Complete AI Training
Sign inGet started

Prompt · Software Developers

Design a Documentation Assistant

Use this when you need to plan or improve a tool that helps developers write clear documentation.

CreatingIntermediateSecurityProduct ManagementIT & Software DevelopmentWriting & Editorial
All 22 prompts in this lesson

How to use it

  1. Copy the prompt and paste it into ChatGPT, Claude, Gemini or any other AI.
  2. Replace every {{placeholder}} with your own details, or let the AI ask you for them.
  3. Use the follow-ups below to go deeper.
Prompt

Role — You are an AI product engineer and technical writer. Your goal is to design a practical documentation assistant that helps developers write clear, concise docs while fitting smoothly into their workflow. Context you provide —

  • {{assistant_type}} — the form the assistant should take (e.g., web interface, editor plugin, CLI, API).
  • {{integration_point}} — where it will live (e.g., VS Code, GitHub PRs, Confluence, custom app).
  • {{project_context}} — the codebase or documentation the assistant must understand (e.g., Python SDK, internal API, user guide).
  • {{output_style}} — desired tone and depth (e.g., beginner-friendly, concise, API reference).

    • Instructions —

  1. Ask for missing context before designing.
  2. Describe the core user flow: how a developer submits content and receives suggestions.
  3. Specify how the assistant should use project context to make relevant recommendations, such as existing doc style, code examples, and terminology.
  4. Recommend the simplest integration approach for the given environment, and justify it.
  5. List key features: grammar and style checks, structure suggestions, context-aware examples, and a feedback loop.
  6. Suggest how to measure and improve the assistant's suggestions over time.

    7. Output format — A design brief with the headings Overview, User Flow, Context Handling, Integration Approach, Feature Set, and Feedback Strategy. Use bullets and keep it under 500 words. Guardrails —

  • Do not invent specific APIs or library names; describe capabilities generically if uncertain.
  • Stay in the documentation-assistant scope, not general content generation.
  • Flag assumptions about the developer platform or team workflow.

    • Example — assistant_type=VS Code extension, integration_point=editor, project_context=internal REST API docs, output_style=concise reference style. Follow-ups —

  • How should the assistant handle code snippets that could have multiple meanings?
  • What would a privacy-preserving version of this assistant look like for proprietary codebases?
  • Can you draft a user story and acceptance criteria for the first version?