Sorry we are currently making room for a hyperspatial express route, please check
your local planning department on Alpha Centauri for more details.
As you begin your journey, there are some simple rules and guidelines you should follow, primarily to increase your chances of survival but also to help your fellow hitchhiker. To learn of these rules click into each corresponding section.
Word to the wise, start at the beginning. Jumping around can be useful but the best way to be most prepared is to read the guide end to end.
Oh and if you are in a time crunch ignore the previous advice and jump to: 🫔 Your Towel: A Doc Writer's Cheat Sheet.
A brief overview of the core philosophies that inform this documentation guide - clarity, usefulness, humor, etc.
How to organize your docs for maximum scanability and findability. Headers, spacing, visual hierarchy, and other structural concepts.
Specific rules of thumb for writing useful, focused documentation content. How to be helpful and concise.
A quick reference guide (our handy towel) with key principles, templates, best practices, and other bits summarized.
Tips for writing clear, readable docs accessible to users of all backgrounds and mother tongues.
A sampler of real-world documentation that exemplifies the guidance provided in this Guide. What excellent docs look like.
This guide is intentionally written in the style of Hitchhiker's Guide to the Galaxy primarily because documentation, and especiallly documenation used to guide you on how to read and write better documenation... can be overwhelmingly boring.
Our hope is that you enjoy reading this guide and that you benefit so much from these divine words of wisdom that you decide to fork it & use it with-in your organization... 🐟 and all!
We'd love to have you join, but we are in closed beta.
You can join our waitlist below.
