It is crucial to the success of this project that the requirements be
unambiguous, and the design clean and efficient and easily understood
by all of the people who are working on the project. It is difficult
for one person to design and implement a complete software package
in isolation. Understand that the documentation for this
project is a dynamic specification, not something which has been finalized and is
unchanging. Here are some of the types of feedback that are requested:
Blanket praise or blanket criticism is not useful. I am looking for
precise suggestions of changes or additional work that needs to be done.
Before embarking on a major task, such as translating all of the documentation
into another language or reorganizing documents, check with me to make sure
that this is something that we want done now, or that someone else is not
already doing this work.
- Suggest additional requirements, or suggest removing or modifying a requirement.
- Explain why a given design is suboptimal, and propose a better one.
- Suggest additional documents that need to be written.
- Suggest reorganizing the existing information into a different set of documents.
- Find spelling and syntax errors.
- Find text that is unclear, and suggest alternate phrasing.
- Translate the documentation into other languages.
For a Go-playing program more than most other types of software, it is
very important that it be accessible to an international audience. It
is the hope of this project that people from all over the world will
contribute their work. That being said, it does not yet make sense
to do any translation work. Just as the source code will not be put
into an official release until it is tested and reviewed, the documentation
set will also not be officially released until it is reviewed and all
comments are addressed. Once there is an official English language
release, then whichever translators have volunteered can perform their
translation, and the official version of the documentation set in those
languages will be released after it is reviewed and all comments addressed.
You may email me at: David Weiss