When people talk about “docs,” they might mean all kinds of things – and honestly, it depends on the context. Here’s a breakdown of the most common terms you’ll run into, explained casually and clearly.
doc / document
This is super broad – could be anything: a design doc, a proposal, notes, or even a spec. When someone says “check the doc,” you usually need to ask which one they mean.
documentation
This refers to the whole system of written support around a project. It usually includes install steps, usage guides, API references, and FAQs. It’s the full experience for helping users and developers.
manual
Think of this as the full instruction book. It’s comprehensive and structured – good for when you want to understand how everything works from top to bottom. Often written for power users or admins.
man page
Short for “manual page,” this is a Unix-style help page. It’s very terse and technical – mostly used for command-line tools, listing flags, syntax, and short examples.
README
This is typically the first thing you see in a repo. It gives a quick overview of the project, how to install or run it, and where to find more info. If you’re skimming a new tool, start here.
specification (spec)
More formal than most docs. A spec defines how something should behave – like a blueprint. It’s often written before implementation and used to align different teams.
introduction
This gives a high-level view of what a tool or system does. It answers: “What is this and why should I care?” Great for beginners or stakeholders.
getting started
This is the quick-start guide – just enough to install the tool, run something basic, and see results. Think “hello world” or first run.
tutorial
Step-by-step walkthroughs that teach you by doing. Ideal when you want to build or try something real while learning how it works.
guide
A guide is broader than a tutorial. It may not be step-by-step, but it helps you understand workflows, best practices, or specific use cases.
reference
This is your “look it up” section. It’s structured like a dictionary – API docs, commands, configs – great when you know what you’re looking for.
FAQ
Stands for “Frequently Asked Questions.” It’s all about support: common errors, misunderstandings, and “gotchas” users run into.
cheatsheet
A quick summary of important info: commands, keyboard shortcuts, syntax – great for fast reference, especially for power users.
Summary
In short, “docs” can mean everything from a casual note to a formal spec. Knowing the difference helps you find what you need faster – whether you’re onboarding, building, or debugging.