Writing good documentation - Githubissues

TechnologyMasters / techmasters.chat

official website for the #TechMasters Slack Group

https://techmasters.chat

Other

12 stars 6 forks source link

Writing good documentation #57

Closed theetrain closed 7 years ago

theetrain commented 7 years ago

How do you write good documentation for a project?

Balancing good linguistics, diagrams, code snippets, and thoroughness
What tools help write good documentation?
Any examples of 'great' documentation you have found? (and bad examples?)

Start here: http://techmasters.slackarchive.io/general/-/1480103595.012434/1480467162.013021/1480363511012545/

theetrain commented 7 years ago

Published: https://techmasters.blog/elements-of-writing-good-documentation-a1fc85173215#.7yt594blc