Technical Writing Prompts

Docs, guides, and writing that users follow instead of ignoring. 16 prompts in this category.

• Quick Start Guide WriterFor the first doc a user reads, where every extra step loses people.
• API Endpoint Documentation WriterFor API docs that developers will read instead of guessing.
• Runbook from Tribal KnowledgeWhen a procedure is one retirement away from being lost.
• Error Message DocumentationFor docs that reduce support tickets by being searchable.
• Glossary BuilderBefore publishing docs full of jargon to a new audience.
• Tutorial from FeatureFor teaching a feature that users will not discover on their own.
• Documentation Structure AuditorWhen docs exist but users still cannot find what they need.
• Release Notes Technical WriterFor developer-facing release notes where clarity prevents breakage.
• Architecture Decision Record DrafterFor recording decisions so the reasoning survives the team.
• Diagram SpecifierBefore opening a diagram tool, so the diagram has a purpose.
• FAQ from Support TicketsFor docs that deflect tickets by answering what people actually ask.
• Onboarding Doc Sequence PlannerBefore a new user drowns in docs with no path through them.
• Code Comment ReviewerFor a codebase where comments have drifted from the code.
• README WriterFor the first file a new contributor or user reads.
• Style Guide DrafterBefore multiple writers make the docs feel like different products.
• Versioning and Changelog PlannerBefore users depend on a version that changes without notice.

Browse every category →