skillZs
★ LIVE SKILL TAGS ★
>>> LIVE SKILLS INDEX <<<
* OPEN SOURCE *
NO LOGIN, NO TRACKING
※ REAL INSTALL DATA ※
← back to all skills
trogonstack/agentskills61 installs

diataxis-organize-docs

Reorganize documentation into the Diataxis framework structure. Splits existing docs into tutorials, how-to guides, reference, and explanation sections.

How do I install this agent skill?

npx skills add https://github.com/trogonstack/agentskills --skill diataxis-organize-docs
view source ↗

Is this agent skill safe to install?

  • Gen Agent Trust Hubpass

    The skill is a documentation reorganization utility following the Diataxis framework. While functional and devoid of direct malicious patterns, it possesses a standard vulnerability surface for indirect prompt injection as it processes untrusted documentation content without defined boundary markers or sanitization logic.

  • Socketpass

    No alerts

  • Snykpass

    Risk: LOW · No issues

  • Runlayerpass

    1 file scanned · No issues

  • ZeroLeakspass

    Score: 93/100 · 2 sections analyzed

What does this agent skill do?

Diataxis Documentation Organization

Reorganize documentation by classifying content into the Diataxis categories and creating a structured documentation hierarchy.

Documentation Categories

QuadrantOrientationPurposeUser Need
TutorialLearningTeach through doing"I want to learn"
How-toTaskSolve specific problems"I want to accomplish X"
ReferenceInformationDescribe the machinery"I need facts about Y"
ExplanationUnderstandingClarify concepts"I want to understand why"

Directory Structure

Organize docs into this hierarchy, adding topic subdirectories as needed:

docs/
├── tutorial/            # Learning-oriented
│   ├── getting-started/
│   └── {topic}/
├── how-to/              # Task-oriented
│   ├── {task-category}/
│   └── troubleshooting/
├── reference/           # Information-oriented
│   ├── api/
│   ├── configuration/
│   └── architecture/
├── explanation/         # Understanding-oriented
│   ├── concepts/
│   ├── decisions/
│   └── background/
└── README.md            # Navigation hub

Always use docs/README.md as the root navigation file, never index.md.

Writing Conventions

Keep skill instructions and generated documentation free of manually maintained totals and numbered section references. Use descriptive headings and named links. For ordered procedures, write each Markdown list marker as 1. so the renderer maintains numbering. Preserve numeric facts that are necessary to understand or use the subject.

Workflow

Load only the references needed for the current task:

  1. Analyze existing content. Classify each file or section by the reader's need. Read classification criteria when classifying existing content or resolving ambiguous categories.
  2. Map the structure. Assign content to the hierarchy above and identify which documents to keep, move, or split.
  3. Separate mixed documents. When a document serves multiple purposes, read splitting guidance for the migration procedure and example. Preserve context and link related content across quadrants.
  4. Build navigation. When creating or updating the documentation hub, read navigation guidance for its template. Update links affected by moved or split content.
  5. Verify and report. Apply the completion checks below. For an audit, report the current state, classifications, proposed file placements, and needed cross-references. For completed edits, summarize the changes and verification. Scale the report to the task.

Completion Checks

  • Each document serves one purpose
  • Tutorials have clear learning outcomes
  • How-to guides solve specific problems
  • Reference is complete and accurate
  • Explanations provide genuine insight
  • Cross-references connect related content and resolve after moves
  • docs/README.md makes user intent clear
  • No orphaned, duplicated, or lost content

Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.

<a href="https://skillzs.dev/skills/trogonstack/agentskills/diataxis-organize-docs">View diataxis-organize-docs on skillZs</a>