Examples of nice docs

• ​Algolia Docs​

• ​Cloudflare Workers (Code) (Article)

• ​Cloudflare Docs - Nice overview page. (Code)

• ​TSDX​

• ​Parcel 2 docs (Code)

• ​Shields.io readme - Clear instructions on how to start working on the project, contributing guidelines pointing to a tutorial, coding guidelines and even a high-level code walkthrough.

• ​inDinero Help Center in Notion - Easy example of doing help/docs for company in Notion.

• ​Formik Docs - NextJS + Notion + TailwindCSS + AlgoliaSearch.

• ​Monzo​

• ​Expo​

• ​Apollo - Lovely search.

• ​Prolens nice ASCII diagrams​

• ​Rome Toolchain - Nice sidebar with table of contents + search.

Notes

• ​Top two mistakes in documentation:​

  1. Assuming people know everything

  2. Assuming people are stupid

• ​If asked a question twice, respond the 3rd time with a URL.​

• ​When done right your documentation is also part of your support, marketing, and even sales.​

Links

• ​Beautiful Docs - Pointers to useful, well-written, and otherwise beautiful documentation.

• ​Ask HN: Is there a better way to document complex software architectures? (2018) -

• ​Docusaurus - Easy to maintain open source documentation websites.

• ​Write the Docs - Global community of people who care about documentation. (Code)

• ​Documentation Guide - Gathers the collective wisdom of the Write the Docs community around best practices for creating software documentation.

• ​Lobsters: What does your company use for documentation? (2019)​

• ​GitDocs - Easy to use, SEO-friendly, beautiful documentation that lives in your git repo.

• ​A Rubric for Open Source Documentation (2019)​

• ​Ask HN: What is key to good technical documentation? (2019)​

• ​Slab - Simple, scalable wiki that knocks down silos. (HN)

• ​How to remove condescending language from documentation (2019)​

• ​Rich docs with Storybook MDX (2019)​

• ​mdBook - Create book from markdown files. Like Gitbook but implemented in Rust.

• ​mdbook-generate-summary - Tool to generate an mdBook SUMMARY.md page.

• ​The Knowledge: Towards a Culture of Engineering Documentation​

• ​We Need a New Document Markup Language - Here is Why (2019)​

• ​Devhints - TL;DR for documentation. (Code)

• ​Metadoc - Online documentation platform where developers collaborate and learn from shared inline notes, bookmarks and comments.

• ​Ask HN: How does your company keep track of lessons learned? (2020)​

• ​Technical Writing Courses for Engineers by Google (HN)

• ​Almanac - Workspace for your team's knowledge.

• ​MkDocs - Project documentation with Markdown.

• ​Docz - Makes it easy to write and publish beautiful interactive documentation for your code. (Web)

• ​gatsby-starter-docz - Gatsby starter with Docz and a blog for your documentation.

• ​Stripe Docs interactive example​

• ​Artifact - Simple, linkable and trackable design documentation tool for everybody.

• ​Gatsby theme for your knowledge base or help center​

• ​Read the Docs - Spend your time on writing high quality documentation, not on the tools to make your documentation work.

• ​cheatset - Generate cheat sheets for Dash.

• ​Doctocat - Gatsby theme for creating Primer documentation sites. (Code)

• ​Docup - Single JavaScript file that fetches Markdown file and renders it as a beautiful one-page documentation. (Code)

• ​RFCs and asynchronous-first culture (2020)​

• ​Today’s Javascript, from an outsider’s perspective (2020) (Lobsters) (HN)

• ​What could be improved in the documentation process? (2020)​

• ​Add a “contrib” directory to your projects (2020) (Lobsters)

• ​Nextra - Next.js based documentation site generator. 0 line of code needed, just write Markdown. (Docs)

• ​Writing inclusive documentation​

• ​Google developer documentation style guide​

• ​ReadMe - Beautiful, personalized, interactive docs.

• ​Favorite docs collection (and why) (2020)​

• ​Ask HN: How do you learn new libraries without much documentation? (2020)​

• ​Design Docs at Google (2020) (HN)

• ​Outline - Open, extensible, wiki for your team built using React and Node.js (Code)

• ​Why Write ADRs (2020) (HN)

• ​I Love MDN, or the cult of the free in action (2020) (HN)

• ​Architecture decision record (ADR) - ADR is document that captures an important architectural decision made along with its context and consequences.

• ​docsify - Magical documentation site generator. (Code)

• ​Just the Docs - Modern, high customizable, responsive Jekyll theme for documention with built-in search.

• ​vite-plugin-react-page - Vite plugin for React. It is very suitable for document site and React UI development environment.

• ​The Documentation Compendium - Various templates & tips on writing high-quality documentation that people want to read.

• ​Smooth Doc - Ready to use documentation theme for Gatsby.

• ​Furo - Clean customizable theme for Sphinx.

• ​MyST - Fully-functional markdown flavor and parser for Sphinx. (Code)

• ​DocuAPI - Beautiful multilingual API documentation theme for Hugo.

• ​Make a readme - Explains what a readme is, what the benefits are, and what makes for a good readme. (Code)

• ​On Apple's Piss-Poor Documentation (2020) (HN)

• ​Tips about making quality engineering documentation (2020)​

• ​Pycco - Literate-style documentation generator.

• ​How to write good documentation (2020)​

• ​The career-changing art of reading the docs (2021)​

• ​DocSearch - Search made for documentation by Algolia. (Code) (Configs)

• ​A Framework for Writing Better Documentation (HN)

• ​Improving Usability by Writing Documentation (2021)​

• ​What nobody tells you about documentation (2017)​

• ​paradoc - One Click Docs.

• ​Ask HN: How to write documentation for a medium size engineering org? (2021)​

• ​Dokz - Effortless documentation with Next.js and MDX. (Web)

• ​Ask HN: How Do You Write Documentation (2021)​

• ​Ask HN: How do I improve boring README page? (2021)​

• ​Docuowl - Generates a static single-page documentation from Markdown files.

• ​The Grand Unified Theory of Documentation (HN)

• ​Writing Docs at Amazon (2019)​

• ​Word usage guidance and alternative terms (HN)