re: What do you expect from a good documentation? VIEW POST


Documentation should definitely unpack the architecture of the system as much as possible. Diagrams are useful for this.

A thorough description of the out-of-the-box behaviour is a basic requirement. If you are documenting a framework I would include examples on overriding or extending default behaviour. If I want to change behaviour X where do I put code Y? What patterns do I use?
I am a Java dev myself so I don't know to what extent this applies to a JavaScript framework, but for me the Spring Project is one of the best documented frameworks out there.


Yes, you are right about the architecture part. Often that's the thing I try to look for in any project that I am trying to incorporate. Half the battle is won once the user knows what goes where.

code of conduct - report abuse