Loading page
About this tool
Build an AI documentation prompt with Diátaxis doc type, audience, scope and code example rules baked in.
The Technical Doc Prompt Builder assembles a complete AI prompt for writing developer documentation, structured around the Diátaxis framework's four document types: tutorial, how-to guide, reference and explanation. It encodes your audience, scope boundaries and code-example language, plus prose rules drawn from the Google and Microsoft developer style guides — second person, present tense, active voice. It is built for developers and technical writers who want AI documentation drafts that follow a real docs architecture instead of generic blog-post structure.
Open Technical Doc Prompt Builder on AltFTool — it loads instantly in your browser.
Paste your code or data sample into the workspace.
Pick the format, conversion, or analysis you need.
Copy the polished result straight back into your project.
Each of the four document types gets its own canonical section outline, not a one-size-fits-all template.
Second person, present tense, active voice and no 'simply' — the common core of the Google and Microsoft style guides.
The prompt forces TODO(author) markers for any version, default or URL you did not supply, instead of hallucinated facts.
Diátaxis is a documentation architecture by Daniele Procida that divides all docs into four types by user need: tutorials (learning-oriented), how-to guides (task-oriented), reference (information-oriented) and explanation (understanding-oriented). Mixing the four in one page is the most common cause of confusing docs, which is why this builder makes you pick one type per prompt.
A tutorial teaches a newcomer by walking them through a guaranteed small success, while a how-to guide helps an already-competent user accomplish one specific real-world task. In Diátaxis terms, tutorials are learning-oriented and assume nothing; how-to guides are task-oriented and may assume working knowledge and an existing setup.
Constrain it to the facts you supply and give it an explicit escape hatch. The prompts generated here instruct the model to use only the supplied details and to write TODO(author) wherever a version number, default value or URL is missing — so gaps surface as visible markers you can fill, instead of invented specifics. Always technically review AI-drafted docs before publishing.
The major developer style guides — Google's and Microsoft's — converge on second person (“you”), present tense, active voice, short sentences and sentence-case headings, and both advise against words like “simply” and “just” that alienate stuck readers. This builder writes those rules directly into every generated prompt.