Documentation Production Skill for ChatGPT: Write Developer Tutorials and References
Choose the audience and document type first. Use supplied code, existing docs, and verification notes to draft a tutorial or reference with prerequisites and checkable outcomes.
中文Install in ChatGPT
Requires a ChatGPT workspace where you can create skills. This is a text adaptation of the pinned GitHub source.
- Review the inputs and outputs in the pinned skills/documentation-production/SKILL.md.
- In ChatGPT, open Plugins, Skills, Create, and Create with editor.
- Write the skill rules using the workflow described here. Use code excerpts, examples, and existing documentation supplied in chat.
- Save the skill and check the fictional example in a new chat.
Example task
Draft a fictional CSV import tutorial for a new teammate. The input needs an email column and blank addresses are skipped and counted. The two-row example has one blank address. Supply the tutorial and its navigation label.What to check
Start with the CSV prerequisite, show a checkable example with one successful import and one skipped row, and provide a navigation label and glossary.
Original SKILL.md on GitHub · Updated
Frequently asked question
How does a tutorial differ from a reference page?
Organize the tutorial around a reader completing a first task. Use a reference page for lookups such as fields, parameters, and boundaries, and link to it where needed.