| name | doc-coauthoring |
| description | Advanced workflow for iterative documentation refinement and reader testing. |
LORE Doc Co-Authoring Skill
Use this skill when tasked with creating or refining complex documentation. This workflow ensures that the final output is contextually accurate and reader-friendly.
Workflow Stages
Stage 1: Context Gathering
- Identify Goals: What is the purpose of the document? Who is the audience?
- Gather Info: Interview the user or research the codebase to capture all necessary details.
Stage 2: Refinement & Structure
- Iterative Drafting: Start with a structure and refine it based on feedback.
- Gap Check: Identify missing information and resolve contradictions.
- Drafting: Write clear, professional content.
Stage 3: Reader Testing
- Predict Reader Questions: What will the reader be confused about?
- Sub-Agent Testing: If possible, ask a sub-agent to "read" the doc and provide feedback.
- Iterate: Fix issues identified during testing.
Quality Standards
- Clarity, conciseness, and accuracy are paramount.
- Maintain a consistent tone throughout the document.
- Use visual hierarchy (headers, lists, alerts) to improve readability.