What makes great documentation?

Every Framework will have a level of complexity. Complexities are better diluted with proper, to the point, teaching aids.

The following is required.

• Diagrams, demonstrating architecture, deployment, processes, flow, context, behaviour and anything else that is required. There must be visual cues.
• Proper documentation of interfaces. .NET supplies us with <summary>. Excellent tool, make sure it is well documented with samples embedded within it with some similar means.
• There should be a central area for obtaining documentation and samples, perhaps on the company intranet or public site. FAQ, Walkthroughs with code are essential
• Accuracy is important
• Too much writing can be in the way, stay to the point.
• The design specification, models or any documents used to design and implement are not good for the end-user. The documentation should be written for the user; where as the audience for the specifications are aimed towards the developer and others. This only brings in confusion.

Do not think that you can get away from documenting your Framework. Without proper documentation, the user will not want to use the framework at all.