Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jenniferlynparsons/awesome-writing

An awesome list of information to help developers write better, kinder, more helpful documentation and learning materials
https://github.com/jenniferlynparsons/awesome-writing

List: awesome-writing

awesome-list documentation resources

Last synced: 3 months ago
JSON representation

An awesome list of information to help developers write better, kinder, more helpful documentation and learning materials

Awesome Lists containing this project

README 

        
# awesome-writing [![Awesome](https://awesome.re/badge.svg)](https://awesome.re)

An awesome list of information to help developers writing better, kinder, more helpful documentation and learning materials



## ["If you propose to speak, always ask yourself, is it true, is it necessary, is it kind?"](https://fakebuddhaquotes.com/if-you-propose-to-speak-always-ask-yourself-is-it-true-is-it-necessary-is-it-kind/)



## Guides



* [Humanizing Your Documentation](https://speakerdeck.com/carolstran/humanizing-your-documentation-lighting-talk)

* [Prose for Programmers](https://github.com/joshuacc/prose-for-programmers)

* [Google Developer Documentation Style Guide](https://developers.google.com/style/)

* [The Best API Documentation](https://bradfults.com/the-best-api-documentation-b9e46400379a)

* [Writing great documentation](https://medium.com/@episod/writing-great-documentation-44d90367115a)

* [The Four Layers to Great Documentation](https://dev.to/ojkelly/the-four-layers-to-great-documentation-dj7)

* [3 Essential Components of Great Documentation](https://dev.to/eli/3-essential-components-of-great-documentation-2cih)

* [How I do Developer UX at Google](https://medium.com/google-design/how-i-do-developer-ux-at-google-b21646c2c4df)

* [Documenting Architecture Decisions](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions)

* [Writing Documentation When You Aren’t A Technical Writer Series](https://medium.com/api-corner/api-documentation/home)

* [What's the best way to document JavaScript?](https://gomakethings.com/whats-the-best-way-to-document-javascript/)

* [How to remove condescending language from documentation](https://dev.to/meeshkan/how-to-remove-condescending-language-from-documentation-4a5p)



## Readmes

* [Writing READMEs](https://www.udacity.com/course/writing-readmes--ud777)

* [Make a README](https://www.makeareadme.com/)



## Writing Technical Tutorials & Posts



* [How to do technical blogging ](https://dev.to/yelluw/how-to-do-technical-blogging)

* [Carbon](https://carbon.now.sh/)

* [Five tips for improving your technical writing and documentation](https://medium.com/@limedaring/five-tips-for-improving-your-technical-writing-and-documentation-47353723c8a7)

* [Tips for Improving Your Technical Writing Skills](https://mmaksimovic.dev/tips-for-improving-your-technical-writing-skills-cjqz11ghs008v84s10domxfeg)

* [7 Pieces of Information to Include in Technical Blog Posts](https://www.stephaniemorillo.co/post/7-pieces-of-information-to-include-in-technical-blog-posts)

* [Notes on Technical Writing](https://mkaz.blog/misc/notes-on-technical-writing/)

* [Enable Learning in Technical Writing](https://mkaz.blog/misc/enable-learning-in-technical-writing/)



## Perspectives



* [“Just”](http://bradfrost.com/blog/post/just/)

* [Write the Docs Podcast](https://itunes.apple.com/us/podcast/write-the-docs-podcast/id1178393510)

* [Mr. Rogers Had a Simple Set of Rules for Talking to Children](https://www.theatlantic.com/family/archive/2018/06/mr-rogers-neighborhood-talking-to-kids/562352/)

* [Lowering the barriers](https://the-pastry-box-project.net/charlotte-spencer/2015-september-16)

* [Lessons Learned in a Year of Docs-Driven Development](https://slides.com/verythorough/ddd-wtd#/)

* [Tales from documentation: Write for your clueless users](https://stackoverflow.blog/2020/07/13/tales-from-documentation-write-for-your-dumbest-user/?utm_source=Iterable&utm_medium=email&utm_campaign=the_overflow_newsletter)

* [The TTS Handbook: A 21st-century approach to internal documentation](https://18f.gsa.gov/2021/07/27/the_tts_handbook_a_21st-century_approach_to_internal_documentation/)



## Other Resources



* [Write the Docs Community](http://www.writethedocs.org/)

* [Increment Issue 6 - Documentation](https://increment.com/documentation/)

* [Docs Like Code](https://www.docslikecode.com/articles/)

* [awesome-readme](https://github.com/matiassingers/awesome-readme)



## Documentation Tools



* [Gitbook](https://www.gitbook.com/)

* [mdBook](https://rust-lang-nursery.github.io/mdBook/)

* [retext-assuming](https://github.com/davidhund/retext-assuming)

* [Alex](http://alexjs.com/)

* [Builder Book](https://builderbook.org/)

* [um - Command line utility for custom man-pages](https://github.com/sinclairtarget/um)

* [DocToc - markdown TOC generation](https://github.com/thlorenz/doctoc)

* [Docusaurus](https://docusaurus.io/)



### JavaScript/React



* [Docco](http://ashkenas.com/docco/)

* [sphinx-js](https://pypi.python.org/pypi/sphinx-js/)

* [JSDoc](http://usejsdoc.org/)

* [Awesome-JavaScript: Documentation](https://github.com/sorrycc/awesome-javascript#documentation)

* [compodoc for Angular](https://compodoc.app/)

* [docz](https://www.docz.site/)



### API



* [Slate](https://github.com/lord/slate)

* [Stoplight](http://stoplight.io/)



### Python



* [Sphinx](http://www.sphinx-doc.org/en/stable/)