How to Start a Document from Scratch
About this sample. My own framework for approaching a new documentation project, developed from experience leading documentation for regulated fintech and GRC products.
Introduction
Writing a document from scratch follows a process similar to developing software. Just as software is built to achieve a defined purpose, a document needs a clear purpose, audience and problem to solve. We can follow a Document Development Life Cycle (DDLC), much like a Software Development Life Cycle (SDLC), to keep that process structured and repeatable.
I use a five-stage approach I call POWER:
- P — Planning
- O — Organizing
- W — Writing
- E — Editing
- R — Release
Here’s how each stage works.
Planning
Planning is where the writer defines the goal, purpose, scope and target audience of the document.
Key steps
- Identify the type of document (user guide, admin guide, API documentation, release notes, and so on).
- Define the target audience and their requirements.
- Determine the tools, template and style guide to use.
- Estimate resources and timeline.
Output: Audience analysis, documentation plan, content outline, template and style guide.
Audience analysis
Understanding who you’re writing for shapes every decision that follows. Different document types serve different audiences with different needs.
Identify your audience
- Demographics: age, location, language, education
- Professional background: job role, industry, technical expertise
Understand their purpose. Are they trying to solve a problem, configure a feature, or learn a new skill?
Understand their expertise level
- Beginner: simple language, step-by-step instructions, visuals
- Intermediate: concise instructions, assumes basic familiarity
- Advanced: technical explanations and references
Customize accordingly
- Tone: formal for a professional audience
- Structure: glossaries and FAQs where useful
- Visuals: diagrams for technical features
Estimate time using
- Novelty: is this a new product or feature?
- Complexity: how difficult is it to set up or use?
- Length: how many steps or features does it cover?
- Risk: what dependencies or risks are involved?
Organizing
This stage is about gathering and structuring the information the document will need. Raw information from subject matter experts is rarely ready to write from directly — it has to be arranged so the final document is accurate, correct and complete.
Key steps
- Interact with subject matter experts, developers and product managers.
- Study the product or software hands-on.
- Review existing documentation for gaps or reusable content.
Output: Collected data, use cases and technical details.
Writing
This is the drafting stage. Working from the planned template and structure, the writer builds the content from the information gathered, including only what’s relevant to the document’s purpose.
Key steps
- Self-review the initial draft to confirm all planned information is included and structured correctly.
- Peer-review with other technical writers, to catch anything a second set of eyes would spot.
- Technical review with SMEs or developers, to confirm accuracy.
- Final edit for grammar, style guide adherence and compliance requirements.
Output: A reviewed and improved documentation draft.
Release
The final stage is releasing the document.
Maintenance. Documentation needs to stay current as requirements and the product evolve.
Key steps
- Update content for new features.
- Respond to user feedback.
- Archive obsolete versions and maintain version control.
Output: Updated, well-maintained documentation.