Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Post History

75%
+4 −0
Q&A Good Examples of and Practices in Code Documentation

I noted in this question: What is the best way to learn technical writing? ...that a rated method to learn how to write technical documents is to imbibe good examples. Can you recommend any exam...

1 answer  ·  posted 9y ago by Stefan Piskorski‭  ·  edited 3y ago by Monica Cellio‭

#5: Post edited by user avatar Monica Cellio‭ · 2021-02-02T16:42:50Z (about 3 years ago)
localized links
  • I noted in this question:
  • [What is the best way to learn technical writing?](https://writers.stackexchange.com/questions/5341/what-is-the-best-way-to-learn-technical-writing/7962#7962)
  • ...that a rated method to learn how to write technical documents is to imbibe good examples.
  • Can you recommend any examples of good code/ database documentation that have proven useful?
  • This was also a really useful thread in terms of documenting code: [How can I write better code-based reference documentation for programming interfaces?](https://writers.stackexchange.com/questions/10501/how-can-i-write-better-code-based-reference-documentation-for-programming-interf)
  • I am documenting a large number of programs so that developers can rewrite and maintain the code and database. The documentation will be directed at developers who will be maintaining and re-writing the code, rather than end-users. Any advice, dos/ don'ts, words to the wise much appreciated.
  • I noted in this question:
  • [What is the best way to learn technical writing?](https://writing.codidact.com/posts/5505#answer-5505)
  • ...that a rated method to learn how to write technical documents is to imbibe good examples.
  • Can you recommend any examples of good code/ database documentation that have proven useful?
  • This was also a really useful thread in terms of documenting code: [How can I write better code-based reference documentation for programming interfaces?](https://writing.codidact.com/posts/9984)
  • I am documenting a large number of programs so that developers can rewrite and maintain the code and database. The documentation will be directed at developers who will be maintaining and re-writing the code, rather than end-users. Any advice, dos/ don'ts, words to the wise much appreciated.
#4: Post edited by user avatar Monica Cellio‭ · 2020-07-10T00:59:02Z (over 3 years ago)
  • I noted in this question:
  • [What is the best way to learn technical writing?](https://writers.stackexchange.com/questions/5341/what-is-the-best-way-to-learn-technical-writing/7962#7962)
  • ...that a rated method to learn how to write technical documents is to imbibe good examples.
  • Can you recommend any examples of good code/ database documentation that have proven useful?
  • This was also a really useful thread in terms of documenting code: [How can I write better code-based reference documentation for programming interfaces?](https://writers.stackexchange.com/questions/10501/how-can-i-write-better-code-based-reference-documentation-for-programming-interf)
  • I am documenting a large number of programs so that developers can rewrite and maintain the code and database. The documentation will be directed at developers who will be maintaining and re-writing the code, rather than end-users. Any advice, dos/ don'ts, words to the wise much appreciated.
  • I noted in this question:
  • [What is the best way to learn technical writing?](https://writers.stackexchange.com/questions/5341/what-is-the-best-way-to-learn-technical-writing/7962#7962)
  • ...that a rated method to learn how to write technical documents is to imbibe good examples.
  • Can you recommend any examples of good code/ database documentation that have proven useful?
  • This was also a really useful thread in terms of documenting code: [How can I write better code-based reference documentation for programming interfaces?](https://writers.stackexchange.com/questions/10501/how-can-i-write-better-code-based-reference-documentation-for-programming-interf)
  • I am documenting a large number of programs so that developers can rewrite and maintain the code and database. The documentation will be directed at developers who will be maintaining and re-writing the code, rather than end-users. Any advice, dos/ don'ts, words to the wise much appreciated.
#3: Attribution notice added by user avatar System‭ · 2019-12-08T03:37:54Z (over 4 years ago)
Source: https://writers.stackexchange.com/q/12417
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision by user avatar Stefan Piskorski‭ · 2019-12-08T03:37:54Z (over 4 years ago)
I noted in this question:

[What is the best way to learn technical writing?](https://writers.stackexchange.com/questions/5341/what-is-the-best-way-to-learn-technical-writing/7962#7962)

...that a rated method to learn how to write technical documents is to imbibe good examples.

Can you recommend any examples of good code/ database documentation that have proven useful?

This was also a really useful thread in terms of documenting code: [How can I write better code-based reference documentation for programming interfaces?](https://writers.stackexchange.com/questions/10501/how-can-i-write-better-code-based-reference-documentation-for-programming-interf)

I am documenting a large number of programs so that developers can rewrite and maintain the code and database. The documentation will be directed at developers who will be maintaining and re-writing the code, rather than end-users. Any advice, dos/ don'ts, words to the wise much appreciated.

#1: Imported from external source by user avatar System‭ · 2014-07-18T09:53:14Z (over 9 years ago)
Original score: 10