Business & Productivity Difficulty: Intermediate

Technical Writing Expert Consultation for Customized Documentation

This prompt guides users through a structured consultation process with a professional technical writing expert to gather detailed project requirements. It systematically collects information about the document’s purpose, target audience, content scope, formatting, visuals, references, objectives, compliance, timeline, and evaluation methods. Based on the user’s responses, it delivers tailored recommendations and strategies for creating clear, concise, and effective technical documentation aligned with industry standards and user needs. Users provide input step-by-step, enabling the expert to customize the output for software, hardware, processes, or procedures documentation.

The prompt

236 words1 blank to fill in

Act as a professional Technical Writing Expert with expertise in creating clear, concise, and effective technical documentation. Based on the provided [TECHNICAL WRITING PROJECT FOCUS OR TOPIC], placeholder, conduct a detailed consultation by asking the user the following key questions one by one: 1) What is the purpose of the technical document (e.g., user manual, technical guide, API documentation)? 2) Who is the intended audience including their technical knowledge level (e.g., end-users, developers, engineers)? 3) What specific topics or subjects must the document cover, and what key information should be communicated? 4) Are there any formatting or style requirements to follow (e.g., brand guidelines, industry standards)? 5) Will the document include visuals such as diagrams, screenshots, or illustrations, and what level of detail is required? 6) Are there existing documentation or reference materials to incorporate? 7) What primary objectives or goals should the document achieve (e.g., instructions, troubleshooting, specifications)? 8) Are there legal or compliance considerations to address? 9) What is the timeline or deadline for project completion? 10) How will the document’s effectiveness be evaluated (e.g., user feedback, performance metrics)? Collect and analyze the user’s responses to each question to extract comprehensive project requirements. Then, provide customized recommendations and strategies for developing high-quality technical documentation that effectively communicates complex information to the target audience. Present the output as a structured consultation report and tailored technical writing plan that guides the documentation process from start to finish.

Highlighted text is a blank. Swap it for your own detail before you send the prompt.

What it produces

  • A detailed consultation report summarizing the user’s project requirements for a software API documentation.
  • A tailored technical writing plan outlining document structure, style guidelines, visual elements, and compliance considerations.
  • Recommendations for incorporating existing reference materials and meeting the project timeline.
  • Strategies for evaluating document effectiveness through user feedback and performance metrics.

How to use this prompt

Four steps, about a minute. Nothing to install and no account needed.

  1. Copy the prompt

    Use the Copy button above. The whole prompt goes to your clipboard exactly as written. Nothing is trimmed.

  2. Fill in the blanks

    Replace [TECHNICAL WRITING PROJECT FOCUS OR TOPIC] with your own detail. Everything in square brackets is a blank for you to fill in.

  3. Paste it into your assistant

    Checked against ChatGPT, Claude, Gemini. It is written as plain instructions, so paste it into whichever of them you already use.

  4. Read the result, then push back

    Compare what you get to the example below. If it is close but not right, say what to change: shorter, warmer, more specific, then ask again in the same conversation.

More prompts like this one

Close neighbours in Business & Productivity, by shared subject and tagging.

Share Technical Writing Expert Consultation for Customized Documentation:

Reviews and questions

What other people got out of this prompt, and what they asked about it.

No reviews yet

Be the first to share how this prompt worked for you.