How you can visually improve your documentation
- Details
- Published: Wednesday, 22 January 2014 21:45
Since the very first version of our VSdocman (.NET class documentation generator) one of the most wanted features was the ability to create additional non-API custom topics.
Overview
SampleClassLibrary Usage
Basic Functionality
Advanced
SampleClassLibrary Reference
Namespace2 API
...
NamespaceN API
License Agreement
About
Appendix: Demo Reference
Namespace1 API
When we implemented this feature, we made many customers happy, judging on their response. Many of then are skilled technical writers so they could immediately create professionally looking documentation with additional topics such as general overview, examples, license agreement, usage descriptions, etc. I had the opportunity to see some of their docs and I could see that they used a lot of screenshots and diagrams. Especially in the introductory topics that described functionality of a technical component.
Recently, for our web site, we needed some basic visualisation of what our VSdocman does. I really liked the hand-drawn objects from infoDiagram. I got a set of charcoal objects from them and within a few minutes I was able to create the first draft of diagram. After some tweaking I was satisfied with the result.
We have some good news here at Helixoft. We have released new major version 4.0 of our 
