<p>Some say documentations are as important as code itself, just like testing. Though there are established, wide-spread best-practices, resources and examples for testing, but not much for documentations. </p>
<p>So:</p>
<ul>
<li>Do you write documentations?</li>
<li>What do you write in your documentations?</li>
<li>What role do you think documentations play in writing good code/software?</li>
<li>What are the best practices you&#39;ve seen/heard/used in writing documentations?</li>
<li>What are you trying to avoid in documentation? (bad practices? common mis-conceptions?) </li>
<li>Suggestions for good resources on documentations?</li>
</ul>


Some say documentations are as important as code itself, just like testing. Though there are established, wide-spread best-practices, resources and examples for testing, but not much for documentations. 

So:
- Do you write documentations?
- What do you write in your documentations?
- What role do you think documentations play in writing good code/software?
- What are the best practices you've seen/heard/used in writing documentations?
- What are you trying to avoid in documentation? (bad practices? common mis-conceptions?) 
- Suggestions for good resources on documentations?



How do you write documentations? What practices do you follow?

Product

Explore

Company

Blogs

Support