Post History
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...
#5: Post edited
by
Monica Cellio
·
2021-02-02T16:42:50Z (almost 4 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
Monica Cellio
·
2020-07-10T00:59:02Z (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.
- 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
System
·
2019-12-08T03:37:54Z (almost 5 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
Stefan Piskorski
·
2019-12-08T03:37:54Z (almost 5 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
System
·
2014-07-18T09:53:14Z (over 10 years ago)
Original score: 10