diff --git a/README.md b/README.md index e979cca..c0a71aa 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Thanks to all [contributors](https://github.com/testthedocs/awesome-docs/graphs/ - [Knowledge Base](#knowledge-base) - [Mockup](#mockup) - [Quality Assurance](#quality-assurance) -- [Style Guides](#style-guides) +- [Reading](#reading) - [Screencast](#screencast) - [Screenshot](#screenshot) - [Site Generators](#site-generators) @@ -34,8 +34,8 @@ Thanks to all [contributors](https://github.com/testthedocs/awesome-docs/graphs/ - [Sphinx Extensions](#sphinx-extensions) - [Sphinx Themes](#sphinx-themes) - [Spelling](#spelling) +- [Style Guides](#style-guides) - [Tool Collection](#tool-collection) -- [Reading](#reading) - [User Behavior Analytics](#user-behavior-analytics) - [Viewer](#viewer) - [Watching](#watching) @@ -143,49 +143,36 @@ Thanks to all [contributors](https://github.com/testthedocs/awesome-docs/graphs/ - [Woke](https://getwoke.tech/) - [Your automated tester](https://squidler.io/) -## Style Guides +## Reading -- [18F](https://content-guide.18f.gov/) -- [Accessibility - MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/Accessibility) -- [Accessible social media content](https://www.accessible-social.com/quick-guide) -- [Aiven](https://github.com/aiven/devportal/blob/main/CONTRIBUTING.rst#style-guide) -- [Apple Style Guide](https://help.apple.com/applestyleguide/) -- [Atlassian](https://atlassian.design/content/) -- [BBC](https://www.bbc.co.uk/editorialguidelines/guidelines) -- [Buffer](https://buffer.com/resources/style-guide/) -- [CLI Guidelines](https://clig.dev/) -- [Container terminology](https://jacobtomlinson.dev/posts/2023/being-intentional-with-container-terminology/) -- [Datagrok](https://datagrok.ai/help/develop/help-pages/writing-style) -- [Developer Style Guide](https://github.com/lornajane/developer-style-guide) -- [DigitalOcean](https://www.digitalocean.com/community/tutorials/digitalocean-s-technical-writing-guidelines) -- [Federal (US) plain language guidelines](https://plainlanguage.gov/guidelines/) -- [GitHub](https://github.com/github/docs/blob/main/contributing/content-style-guide.md#content-style-guide-for-github-docs-) -- [GitLab](https://docs.gitlab.com/ee/development/documentation/styleguide/) -- [Google](https://developers.google.com/style/) -- [Guidelines for Inclusive Language](https://guides.18f.gov/content-guide/our-style/inclusive-language/) -- [Human words for technical docs](https://coda.io/@dave-connis/human-words-for-technical-docs) -- [Linode](https://www.linode.com/docs/linode-writers-formatting-guide/) -- [Mailchimp](https://styleguide.mailchimp.com/) -- [Markdown Guide](https://www.markdownguide.org/) -- [Michigan State University](https://msu.edu/course/be/485/bewritingguideV2.0.pdf) -- [Microsoft](https://docs.microsoft.com/en-us/style-guide/welcome/) -- [MongoDB](https://www.mongodb.com/docs/meta/style-guide/) -- [Monzo](https://monzo.com/tone-of-voice/) -- [NC State University - IT Accessibility Handbook](https://accessibility.oit.ncsu.edu/it-accessibility-at-nc-state/developers/accessibility-handbook/) -- [Rackspace](https://github.com/rackerlabs/docs-style-guide/tree/master/style-guide) -- [Red Hat Guidelines](https://redhat-documentation.github.io/) -- [Red Hat Style Guide](https://stylepedia.net/style/) -- [Salesforce](https://developer.salesforce.com/docs/atlas.en-us.salesforce_pubs_style_guide.meta/salesforce_pubs_style_guide/overview.htm) -- [Shopify](https://polaris.shopify.com/content/product-content) -- [Splunk](https://docs.splunk.com/Documentation/StyleGuide/latest/StyleGuide/Howtouse) -- [Sprout](https://sproutsocial.com/seeds/writing/) -- [SUSE](https://documentation.suse.com/style/current/single-html/docu_styleguide/) -- [The essential guide to conscious language](https://consciousstyleguide.com/) -- [The Writer](http://www.thewriter.com/what-we-think/style-guide/) -- [United Nations](https://www.un.org/dgacm/content/editorial-manual) -- [Web Content Accessibility Guidelines](https://www.w3.org/TR/WCAG21/) -- [Website Style Guide Resources](http://styleguides.io/) -- [Write The Docs](https://www.writethedocs.org/guide/writing/style-guides/) +- [A Guide to Creating Personas](https://marvelapp.com/blog/creating-personas/) +- [API Handyman](https://apihandyman.io/) +- [API Knowledge](https://postman-toolboxes.github.io/api-knowledge/) +- [Automating Your Accessibility Tests](https://24ways.org/2017/automating-your-accessibility-tests) +- [Awesome Documentation](https://github.com/vipulgupta2048/awesome-documentation) +- [Become a better writer as a developer](https://dev.to/dhaiwat10/become-a-better-writer-as-a-developer-46oc) +- [Become a technical writer](https://www.instructionalsolutions.com/blog/become-a-technical-writer) +- [Document Like a Scientist](https://noti.st/karissapeth/g3vUiw/document-like-a-scientist) +- [Free Resources to Learn Technical Writing](https://medium.com/@ann.green/free-resources-to-learn-technical-writing-7d642020cda9) +- [Google - Technical Writing Courses](https://developers.google.com/tech-writing) +- [Grammarly Blog](https://www.grammarly.com/blog/) +- [Great Developer Documentation Examples](https://everydeveloper.com/developer-documentation-examples/) +- [How Google, Twitter, and Spotify built a culture of documentation](https://dev.to/doctave/how-google-twitter-and-spotify-built-a-culture-of-documentation-3e0m) +- [How to write technical posts](https://reasonablypolymorphic.com/blog/writing-technical-posts/) +- [Let's Get Intentional About Documentation](https://counting.substack.com/p/lets-get-intentional-about-documentation) +- [Mastering cURL](https://dev.to/mkinoshita12/mastering-curl-going-from-junior-to-senior-level-debugging-skills-5d80) +- [Maybe it’s time we re-think docs](https://kathkorevec.medium.com/building-a-better-place-for-docs-197f92765409) +- [Scottydocs.com](https://github.com/scottydocs) +- [Setting up the alex.js language linter in your project](https://dev.to/unmock/setting-up-the-alex-js-language-linter-in-your-project-3bpl) +- [Systematic approach to technical documentation authoring](https://diataxis.fr/) +- [Technical Documentation in Software Development](https://www.altexsoft.com/blog/business/technical-documentation-in-software-development-types-best-practices-and-tools/) +- [Technical Documentation Tool and Web Guide](https://www.indoition.com/tools-websites-technical-documentation.htm) +- [User Guide Template](https://clickhelp.com/clickhelp-technical-writing-blog/user-guide-template/) +- [What nobody tells you about documentation](https://www.divio.com/blog/documentation/) +- [Why does inclusive language matter](https://writer.com/inclusion-glossary/) +- [Write good examples by starting with real code](https://jvns.ca/blog/2021/07/08/writing-great-examples/) +- [Writing great documentation](https://medium.com/@episod/writing-great-documentation-44d90367115a) +- [Writing Technical Stuff for Non-Technical Readers](https://quickfix.es/2020/10/the-baseline/) ## Screencast @@ -268,6 +255,50 @@ Thanks to all [contributors](https://github.com/testthedocs/awesome-docs/graphs/ - [PySpelling](https://facelessuser.github.io/pyspelling/) +## Style Guides + +- [18F](https://content-guide.18f.gov/) +- [Accessibility - MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/Accessibility) +- [Accessible social media content](https://www.accessible-social.com/quick-guide) +- [Aiven](https://github.com/aiven/devportal/blob/main/CONTRIBUTING.rst#style-guide) +- [Apple Style Guide](https://help.apple.com/applestyleguide/) +- [Atlassian](https://atlassian.design/content/) +- [BBC](https://www.bbc.co.uk/editorialguidelines/guidelines) +- [Buffer](https://buffer.com/resources/style-guide/) +- [CLI Guidelines](https://clig.dev/) +- [Container terminology](https://jacobtomlinson.dev/posts/2023/being-intentional-with-container-terminology/) +- [Datagrok](https://datagrok.ai/help/develop/help-pages/writing-style) +- [Developer Style Guide](https://github.com/lornajane/developer-style-guide) +- [DigitalOcean](https://www.digitalocean.com/community/tutorials/digitalocean-s-technical-writing-guidelines) +- [Federal (US) plain language guidelines](https://plainlanguage.gov/guidelines/) +- [GitHub](https://github.com/github/docs/blob/main/contributing/content-style-guide.md#content-style-guide-for-github-docs-) +- [GitLab](https://docs.gitlab.com/ee/development/documentation/styleguide/) +- [Google](https://developers.google.com/style/) +- [Guidelines for Inclusive Language](https://guides.18f.gov/content-guide/our-style/inclusive-language/) +- [Human words for technical docs](https://coda.io/@dave-connis/human-words-for-technical-docs) +- [Linode](https://www.linode.com/docs/linode-writers-formatting-guide/) +- [Mailchimp](https://styleguide.mailchimp.com/) +- [Markdown Guide](https://www.markdownguide.org/) +- [Michigan State University](https://msu.edu/course/be/485/bewritingguideV2.0.pdf) +- [Microsoft](https://docs.microsoft.com/en-us/style-guide/welcome/) +- [MongoDB](https://www.mongodb.com/docs/meta/style-guide/) +- [Monzo](https://monzo.com/tone-of-voice/) +- [NC State University - IT Accessibility Handbook](https://accessibility.oit.ncsu.edu/it-accessibility-at-nc-state/developers/accessibility-handbook/) +- [Rackspace](https://github.com/rackerlabs/docs-style-guide/tree/master/style-guide) +- [Red Hat Guidelines](https://redhat-documentation.github.io/) +- [Red Hat Style Guide](https://stylepedia.net/style/) +- [Salesforce](https://developer.salesforce.com/docs/atlas.en-us.salesforce_pubs_style_guide.meta/salesforce_pubs_style_guide/overview.htm) +- [Shopify](https://polaris.shopify.com/content/product-content) +- [Splunk](https://docs.splunk.com/Documentation/StyleGuide/latest/StyleGuide/Howtouse) +- [Sprout](https://sproutsocial.com/seeds/writing/) +- [SUSE](https://documentation.suse.com/style/current/single-html/docu_styleguide/) +- [The essential guide to conscious language](https://consciousstyleguide.com/) +- [The Writer](http://www.thewriter.com/what-we-think/style-guide/) +- [United Nations](https://www.un.org/dgacm/content/editorial-manual) +- [Web Content Accessibility Guidelines](https://www.w3.org/TR/WCAG21/) +- [Website Style Guide Resources](http://styleguides.io/) +- [Write The Docs](https://www.writethedocs.org/guide/writing/style-guides/) + ## Tool Collection - [adr-tools](https://github.com/npryce/adr-tools) @@ -296,37 +327,6 @@ Thanks to all [contributors](https://github.com/testthedocs/awesome-docs/graphs/ - [vendir](https://carvel.dev/vendir/) - [Writerside](https://www.jetbrains.com/writerside/) -## Reading - -- [A Guide to Creating Personas](https://marvelapp.com/blog/creating-personas/) -- [API Handyman](https://apihandyman.io/) -- [API Knowledge](https://postman-toolboxes.github.io/api-knowledge/) -- [Automating Your Accessibility Tests](https://24ways.org/2017/automating-your-accessibility-tests) -- [Awesome Documentation](https://github.com/vipulgupta2048/awesome-documentation) -- [Become a better writer as a developer](https://dev.to/dhaiwat10/become-a-better-writer-as-a-developer-46oc) -- [Become a technical writer](https://www.instructionalsolutions.com/blog/become-a-technical-writer) -- [Document Like a Scientist](https://noti.st/karissapeth/g3vUiw/document-like-a-scientist) -- [Free Resources to Learn Technical Writing](https://medium.com/@ann.green/free-resources-to-learn-technical-writing-7d642020cda9) -- [Google - Technical Writing Courses](https://developers.google.com/tech-writing) -- [Grammarly Blog](https://www.grammarly.com/blog/) -- [Great Developer Documentation Examples](https://everydeveloper.com/developer-documentation-examples/) -- [How Google, Twitter, and Spotify built a culture of documentation](https://dev.to/doctave/how-google-twitter-and-spotify-built-a-culture-of-documentation-3e0m) -- [How to write technical posts](https://reasonablypolymorphic.com/blog/writing-technical-posts/) -- [Let's Get Intentional About Documentation](https://counting.substack.com/p/lets-get-intentional-about-documentation) -- [Mastering cURL](https://dev.to/mkinoshita12/mastering-curl-going-from-junior-to-senior-level-debugging-skills-5d80) -- [Maybe it’s time we re-think docs](https://kathkorevec.medium.com/building-a-better-place-for-docs-197f92765409) -- [Scottydocs.com](https://github.com/scottydocs) -- [Setting up the alex.js language linter in your project](https://dev.to/unmock/setting-up-the-alex-js-language-linter-in-your-project-3bpl) -- [Systematic approach to technical documentation authoring](https://diataxis.fr/) -- [Technical Documentation in Software Development](https://www.altexsoft.com/blog/business/technical-documentation-in-software-development-types-best-practices-and-tools/) -- [Technical Documentation Tool and Web Guide](https://www.indoition.com/tools-websites-technical-documentation.htm) -- [User Guide Template](https://clickhelp.com/clickhelp-technical-writing-blog/user-guide-template/) -- [What nobody tells you about documentation](https://www.divio.com/blog/documentation/) -- [Why does inclusive language matter](https://writer.com/inclusion-glossary/) -- [Write good examples by starting with real code](https://jvns.ca/blog/2021/07/08/writing-great-examples/) -- [Writing great documentation](https://medium.com/@episod/writing-great-documentation-44d90367115a) -- [Writing Technical Stuff for Non-Technical Readers](https://quickfix.es/2020/10/the-baseline/) - ## User Behavior Analytics - [Clarity](https://clarity.microsoft.com/)