I plan to write a new documentation system, because I couldn't find any system that suites my / our needs at amphp. It has to support multiple packages and their various versions (at least major.minor
, bugfix
versions will just update the current version). Furthermore, there needs to be support for tutorial series. It's planned to build these from markdown files in ./doc
currently.
But we can write as much documentation as we like, the key point is that it must be usable for those that really need the documentation to learn how things work. So I'm asking you here. As a new user of a framework / library / package, what's your preference?
- What do you need in a documentation system?
- What is your preferred way for navigation?
- What should tutorial series look like?
And two more questions if you want to publish your own documentation:
- How do you want to write documentation?
- How do you want to handle versions?
For the latter two questions: