All Questions
3 questions
28
votes
2
answers
52k
views
How to do documentation for code and why is software (often) poorly documented?
There are some good examples of well-documented code out there, such as java api. But, a lot of code in public projects such as git and internal projects of companies is poorly documented and not very ...
- 407
-1
votes
1
answer
131
views
What are the most crucial categories of content to organize into an internal developer portal in a large company? [closed]
I have been tasked with organizing all of the company's internal content currently spread around sharepoint, a markdown reference manual and confluence into a single cohesive and usable portal in ...
- 1,469
11
votes
3
answers
2k
views
Are XML Comments Necessary Documentation?
I used to be a fan of requiring XML comments for documentation. I've since changed my mind for two main reasons:
Like good code, methods should be self-explanatory.
In practice, most XML ...
- 2,347