ChatGPT Documentation Prompt for Technical Writers
A specialized prompt combining ChatGPT's capabilities with Technical Writer workflows for documentation. This template helps Technical Writers write documentation using ChatGPT's code interpreter and dall-e integration.
I'm a Technical Writer using ChatGPT and I need to write documentation. ## My Role & Context - Role: Technical Writer - Primary responsibility: Product documentation - Tool: ChatGPT ## The Task [Describe what you need to write documentation] ## Code/Content ``` [Paste relevant code or content] ``` ## Requirements - Approach should fit Technical Writer workflows - Leverage ChatGPT's code interpreter - Focus on documentation best practices ## Expected Output Please provide: 1. Analysis relevant to my role as a Technical Writer 2. Step-by-step approach to write documentation 3. How to use ChatGPT effectively for this task
How to Use This Prompt
- 1
Copy the prompt template
Click the copy button above to copy the prompt to your clipboard.
- 2
Open ChatGPT
Start a new conversation or use the appropriate input area.
- 3
Customize the placeholders
Replace all text in [brackets] with your specific context and requirements.
- 4
Submit and iterate
Review the response and ask follow-up questions to refine the output.
Tips for Better Results
- •ChatGPT excels at code interpreter - leverage this for documentation tasks
- •As a Technical Writer, frame your documentation requests in terms of product documentation
- •Use ChatGPT's dall-e integration to iterate on the results
- •Ask for explanations that help you learn documentation best practices
- •Save this prompt as a Retext snippet: ;chdote
Prompt Variations
[Technical Writer + ChatGPT] Write documentation this with focus on [specific aspect]: ``` [code] ``` Consider my workflow of product documentation.
Using ChatGPT as a Technical Writer, create a documentation guide for: [describe project/code] Include ChatGPT-specific tips.
I'm a Technical Writer who needs to write documentation regularly. Help me create a reusable ChatGPT workflow for this.
Frequently Asked Questions
What makes this ChatGPT Documentation Prompt for Technical Writers effective?
This template is structured to provide ChatGPT with the right context for the task. It includes placeholders for your project details, clear requirements, and expected output format, helping you get more accurate and useful responses.
How do I customize this prompt for my needs?
Replace all text in [brackets] with your specific information. Include relevant code snippets, describe your tech stack, and specify any constraints or requirements unique to your situation. The more context you provide, the better the results.
Can I save this prompt for quick access?
Yes! Use Retext to save this prompt as a text snippet. Create a trigger like ';prompt' and paste this template as the expansion. Then you can quickly access it anywhere by typing your trigger.
Save This Prompt with Retext
Never copy-paste this prompt again. Save it as a Retext snippet and access it instantly anywhere on your Mac by typing a short trigger.