├── .github └── FUNDING.yml ├── LICENSE └── README.md /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: jenniferlynparsons 2 | patreon: jenniferparsons 3 | ko_fi: pixelpaperyarn 4 | custom: ["https://www.buymeacoffee.com/pixelpaperyarn"] 5 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | This is free and unencumbered software released into the public domain. 2 | 3 | Anyone is free to copy, modify, publish, use, compile, sell, or 4 | distribute this software, either in source code form or as a compiled 5 | binary, for any purpose, commercial or non-commercial, and by any 6 | means. 7 | 8 | In jurisdictions that recognize copyright laws, the author or authors 9 | of this software dedicate any and all copyright interest in the 10 | software to the public domain. We make this dedication for the benefit 11 | of the public at large and to the detriment of our heirs and 12 | successors. We intend this dedication to be an overt act of 13 | relinquishment in perpetuity of all present and future rights to this 14 | software under copyright law. 15 | 16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 17 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 18 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 19 | IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR 20 | OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 21 | ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 22 | OTHER DEALINGS IN THE SOFTWARE. 23 | 24 | For more information, please refer to 25 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # awesome-writing [![Awesome](https://awesome.re/badge.svg)](https://awesome.re) 2 | An awesome list of information to help developers writing better, kinder, more helpful documentation and learning materials 3 | 4 | ## ["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/) 5 | 6 | 7 | ## Guides 8 | 9 | * [Humanizing Your Documentation](https://speakerdeck.com/carolstran/humanizing-your-documentation-lighting-talk) 10 | * [Prose for Programmers](https://github.com/joshuacc/prose-for-programmers) 11 | * [Google Developer Documentation Style Guide](https://developers.google.com/style/) 12 | * [The Best API Documentation](https://bradfults.com/the-best-api-documentation-b9e46400379a) 13 | * [Writing great documentation](https://medium.com/@episod/writing-great-documentation-44d90367115a) 14 | * [The Four Layers to Great Documentation](https://dev.to/ojkelly/the-four-layers-to-great-documentation-dj7) 15 | * [3 Essential Components of Great Documentation](https://dev.to/eli/3-essential-components-of-great-documentation-2cih) 16 | * [How I do Developer UX at Google](https://medium.com/google-design/how-i-do-developer-ux-at-google-b21646c2c4df) 17 | * [Documenting Architecture Decisions](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions) 18 | * [Writing Documentation When You Aren’t A Technical Writer Series](https://medium.com/api-corner/api-documentation/home) 19 | * [What's the best way to document JavaScript?](https://gomakethings.com/whats-the-best-way-to-document-javascript/) 20 | * [How to remove condescending language from documentation](https://dev.to/meeshkan/how-to-remove-condescending-language-from-documentation-4a5p) 21 | 22 | 23 | ## Readmes 24 | * [Writing READMEs](https://www.udacity.com/course/writing-readmes--ud777) 25 | * [Make a README](https://www.makeareadme.com/) 26 | 27 | 28 | ## Writing Technical Tutorials & Posts 29 | 30 | * [How to do technical blogging ](https://dev.to/yelluw/how-to-do-technical-blogging) 31 | * [Carbon](https://carbon.now.sh/) 32 | * [Five tips for improving your technical writing and documentation](https://medium.com/@limedaring/five-tips-for-improving-your-technical-writing-and-documentation-47353723c8a7) 33 | * [Tips for Improving Your Technical Writing Skills](https://mmaksimovic.dev/tips-for-improving-your-technical-writing-skills-cjqz11ghs008v84s10domxfeg) 34 | * [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) 35 | * [Notes on Technical Writing](https://mkaz.blog/misc/notes-on-technical-writing/) 36 | * [Enable Learning in Technical Writing](https://mkaz.blog/misc/enable-learning-in-technical-writing/) 37 | 38 | 39 | ## Perspectives 40 | 41 | * [“Just”](http://bradfrost.com/blog/post/just/) 42 | * [Write the Docs Podcast](https://itunes.apple.com/us/podcast/write-the-docs-podcast/id1178393510) 43 | * [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/) 44 | * [Lowering the barriers](https://the-pastry-box-project.net/charlotte-spencer/2015-september-16) 45 | * [Lessons Learned in a Year of Docs-Driven Development](https://slides.com/verythorough/ddd-wtd#/) 46 | * [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) 47 | * [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/) 48 | 49 | 50 | ## Other Resources 51 | 52 | * [Write the Docs Community](http://www.writethedocs.org/) 53 | * [Increment Issue 6 - Documentation](https://increment.com/documentation/) 54 | * [Docs Like Code](https://www.docslikecode.com/articles/) 55 | * [awesome-readme](https://github.com/matiassingers/awesome-readme) 56 | 57 | 58 | ## Documentation Tools 59 | 60 | * [Gitbook](https://www.gitbook.com/) 61 | * [mdBook](https://rust-lang-nursery.github.io/mdBook/) 62 | * [retext-assuming](https://github.com/davidhund/retext-assuming) 63 | * [Alex](http://alexjs.com/) 64 | * [Builder Book](https://builderbook.org/) 65 | * [um - Command line utility for custom man-pages](https://github.com/sinclairtarget/um) 66 | * [DocToc - markdown TOC generation](https://github.com/thlorenz/doctoc) 67 | * [Docusaurus](https://docusaurus.io/) 68 | 69 | ### JavaScript/React 70 | 71 | * [Docco](http://ashkenas.com/docco/) 72 | * [sphinx-js](https://pypi.python.org/pypi/sphinx-js/) 73 | * [JSDoc](http://usejsdoc.org/) 74 | * [Awesome-JavaScript: Documentation](https://github.com/sorrycc/awesome-javascript#documentation) 75 | * [compodoc for Angular](https://compodoc.app/) 76 | * [docz](https://www.docz.site/) 77 | 78 | ### API 79 | 80 | * [Slate](https://github.com/lord/slate) 81 | * [Stoplight](http://stoplight.io/) 82 | 83 | ### Python 84 | 85 | * [Sphinx](http://www.sphinx-doc.org/en/stable/) 86 | --------------------------------------------------------------------------------