StructuredFor DevelopersDeveloper Productivity & Career

Technical Writing Toolkit.

When writing technical documentation that must influence decisions, teach others, or be a permanent record.

ChatGPT Β· Claude Β· GeminiΒ·IntermediateΒ·~900 tokens
Curated by the AIPP team
Last updated 14 May 2026 Β· v3
technical-writing-toolkit-4.md Β· 900 words
You are a senior {{role}} brought in to help a developer or tech professional complete a {{use_case}} task.

# Context
- Pack: Developers & Tech Professionals
- Category: Developer Productivity & Career
- Use case: Technical Writing Toolkit
- Source task:
  - Help me write {{type_of_technical_document_rfc_adr_post_mortem_onboarding_guide_}} about {{topic}}. Include:
  - 1. the standard structure for this document type
  - 2. a complete draft of the document based on: {{describe_the_context}}
  - 3. common mistakes in this document type and how to avoid them
  - 4. how to make it scannable for a busy engineering audience
  - 5. review checklist before publishing

# Goal
Document type structure, complete draft, common mistake guide, scannability tips, and a pre-publish checklist.

# Constraints
- Produce a complete, usable first draft in one response.
- Avoid generic filler, vague advice, and unsupported claims.
- Make the output specific, practical, and ready to use.

# Output
Document type structure, complete draft, common mistake guide, scannability tips, and a pre-publish checklist.

The variables to fill in

PlaceholderWhat to put thereExample
{{role}}Roletechnical communication expert
{{use_case}}Your specific valuetechnical writing toolkit
{{type_of_technical_document_rfc_adr_post_mortem_onboarding_guide_}}Type of technical document rfc adr post mortem onboarding guide TYPE OF TECHNICAL DOCUMENT: RFC
{{topic}}Topicclimate change policy
{{describe_the_context}}Describe the contextExample describe the context

How to customize this prompt

  1. Replace each {{double-curly}} with your real context.
  2. Adjust the constraints section to match your tone β€” formal, casual, blunt.
  3. If the engagement is recurring, change the duration line to mention milestones rather than days.
  4. Run it in your tool of choice. The output should be ready to paste with at most one small edit.

When to use

When writing technical documentation that must influence decisions, teach others, or be a permanent record.

PRO TIP

An RFC that isn't read doesn't exist β€” write the executive summary first and make sure it stands alone for busy stakeholders.

Related prompts

Structured

Blog Post Drafting Engine

Write a complete, SEO-optimised blog post on the given topic. Include a compelling headline, an engaging introduction, 4-5 subheadings with detailed body paragraphs, and a strong conclusion with a cal

Structured

Email Newsletter Writer

Write a complete email newsletter including subject line, preview text, opening hook, main body content (3 short sections), and a clear call to action.

Structured

YouTube Video Script Writer

Write a complete YouTube video script including a strong hook (first 30 seconds), structured main content with transitions, and a closing that encourages likes, comments, and subscriptions.

Structured

LinkedIn Article Builder

Write a complete LinkedIn article that establishes professional authority, shares a genuine insight, and encourages professional discussion.

β˜… THIS PROMPT IS IN A PACK

The Developer Toolkit Pack

250 technical prompts for code review, documentation, architecture planning, debugging, test writing, API design, and career growth β€” built by developers for developers.

Browse more prompts β†’