home/writing/spell-doc-restructure

Spell Doc Restructure

GPTClaudeGemini··1,254 copies·updated 2026-07-14
spell-doc-restructure.prompt
## Summary

**Reorganize existing documentation by purpose and detail level.** Applies topic-based authoring (each doc = self-contained module), Diataxis (quadrant separation), progressive disclosure (depth layering), and EPPO (each page stands alone). Restructures incrementally using the strangler fig approach — piece by piece, not all at once.

**Arguments:** `$ARGUMENTS` (required) - Path to docs to restructure

**Output:** Restructured documentation with navigation, index, and change summary output directly to the conversation (Write is available if the user requests the output be saved to files)

---

## Skill References

Before proceeding, load the relevant skill documents for reference:

Read the following files from the repository root:
- `docs/skills/diataxis-framework.md`
- `docs/skills/progressive-disclosure-framework.md`

---

## Process

### Step 1: Scan and Classify

Find all markdown files in the target path. Read each file.

For each document, classify along two dimensions:

**Diataxis quadrant:** Tutorial, How-to, Reference, or Explanation (flag mixed-quadrant docs)
**Progressive disclosure level:** Overview (L1), Getting Started (L2), Guide (L3), Reference (L4), Deep Dive (L5)

Also assess the current navigation patterns: Are files linked? Is there an entry point? What's the reading order?

**If `$ARGUMENTS` is empty:**
Ask the user what documentation path to restructure.

**Output the classification:**

when to use it

Community prompt sourced from the open-source GitHub repo smileynet/sams-genai-spells (MIT). A "Spell Doc Restructure" style prompt — adapt the placeholders and specifics to your task. Imported as-is and not independently retested here, so check the output before relying on it.

tags

writingcommunitygeneral

source

smileynet/sams-genai-spells · MIT