Documentation Knowledge Skill for ChatGPT: Plan README, Guide and API Reference Structure
Map documentation entry points to evaluators, new users, integrators, and contributors. Decide where quickstarts, reference, architecture, and decision records belong.
中文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-knowledge/SKILL.md.
- In ChatGPT, open Plugins, Skills, Create, and Create with editor.
- Write the skill rules using the workflow described here. Provide the project purpose, audience roles, current navigation, and material inventory.
- Save the skill and check the fictional example in a new chat.
Example task
A fictional tool serves new users, API integrators, and contributors. Its README holds 20 API fields and old design rationale. Propose a documentation structure.What to check
Keep purpose, a minimal example, and navigation in the README. Move field details to reference and rationale to an ADR. Link contributor setup from the contribution guide.
Original SKILL.md on GitHub · Updated
Frequently asked question
How do I decide between a tutorial and reference?
Use a tutorial for completing a first task in sequence. Use reference for looking up fields, options, or interface behavior, and link between them.