How to fix tech docs
One of the recent GitHub surveys reveals that one of the top problems with open source projects is incomplete or confusing documentation.
1. Explain the tool interface and its components! . Like some tools are really difficult to use. so this interface and components are really helpful.
2. Give examples with images, gif, charts, graphs, etc. I mean just add visuals to make the journey of documentation beautiful.
3. Provide text/ video tutorials and how-tos. Like you can build a separate section of Tutorials!
Well you can create a gallery of high-level tuts and how-tos
4. There are 2 types of documentation: API and GUI documentation.
API documentation is a bit biased towards the developers and GUI is more of a work for UI UX designers.
5. You can create a section dedicated to beginners only.
6. You need to create a virtual environment on your local machine in order to understand the tech, tools, and docs of the organization like GIT, NPM, etc.
7. Present examples in a visual way if possible.
0 Comments:
Post a Comment
Subscribe to Post Comments [Atom]
<< Home