agentleFS
ITS-MSWITS-MSW/skills/universal-docs/SKILL.md

universal-docs

Skill2 starsChanged 5 months agoMITView on GitHub

This skill enforces a strict, professional documentation workflow. It prevents the AI from instantly generating massive blocks of text by forcing a structured planning phase and adhering to the Diátaxis framework. You must NEVER immediately write the full documentation. You must follow these three phases in order: Action: Ask the user to confirm the category and provide any missing context (target audience, tech stack, key constraints). If the user specifically requests an ADR or an llms.txt file, bypass the Diátaxis…

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 1

    1. PURPLE-ORCA/skills★ 2100% same

    Edited · 0

    None found.

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository7 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

6 rules. About 0 are common, 5 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    When the user asks for documentation, you must first categorize the request using the Diátaxis Framework:

    line 16
  2. Distinctive:

    Action: Ask the user to confirm the category and provide any missing context (target audience, tech stack, key constraints).

    line 22
  3. Distinctive:

    Action: STOP. Ask the user: *"Does this outline look correct, or do we need to adjust the structure?"* Do not proceed to Phase 3 until …

    line 26
  4. Very specific:

    If the user specifically requests an ADR or an llms.txt file, bypass the Diátaxis categorization and use these exact structures.

    line 38
  5. Distinctive:

    Use this when documenting a major technical shift (e.g., migrating to Inertia v3, choosing Convex, abandoning a library).

    line 41
  6. Distinctive:

    Use this when creating an AI-readable index for a repository.

    line 66

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Universal Docs Architect

This skill enforces a strict, professional documentation workflow. It prevents the AI from instantly generating massive blocks of text by forcing a structured planning phase and adhering to the Diátaxis framework.

The Execution Loop (MANDATORY)

You must NEVER immediately write the full documentation. You must follow these three phases in order:

Phase 1: Interrogation & Categorization

When the user asks for documentation, you must first categorize the request using the Diátaxis Framework:

  1. Tutorials: Learning-oriented. Hand-holding a beginner through a project.
  2. How-To Guides: Goal-oriented. Step-by-step instructions to solve a specific problem.
  3. Reference: Information-oriented. Dry, accurate technical descriptions (APIs, configs).
  4. Explanation: Understanding-oriented. High-level architecture, design choices, and theory.

Action: Ask the user to confirm the category and provide any missing context (target audience, tech stack, key constraints).

Phase 2: The Outline Hold

Once the category and context are confirmed, generate a strict, bulleted outline of the proposed documentation. Action: STOP. Ask the user: "Does this outline look correct, or do we need to adjust the structure?" Do not proceed to Phase 3 until explicit approval is given.

Phase 3: Execution (The "February Guide" Standard)

Once approved, write the documentation. The output must match the elite quality standard established for "The Guide":

  • Formatting: Heavy use of tables, code blocks, bold emphasis for critical paths, and collapsible sections if the markdown flavor supports it.
  • Tone: Direct, rational, and unfiltered. Zero fluff. No introductory filler like "In the ever-evolving world of web development..."
  • Clarity: Assume the reader is a competent developer who is just short on time. Give them the "what," the "how," and the "why," then get out of the way.

Required Templates

If the user specifically requests an ADR or an llms.txt file, bypass the Diátaxis categorization and use these exact structures.

Template 1: Architecture Decision Record (ADR)

Use this when documenting a major technical shift (e.g., migrating to Inertia v3, choosing Convex, abandoning a library).

# ADR [Number]: [Short Noun Phrase describing the decision]

**Date:** YYYY-MM-DD
**Status:** [Proposed | Accepted | Deprecated | Superseded]

## Context
What is the technical or business problem? Why are we making a change now? Keep it objective and factual.

## Decision
What is the exact change we are making? Be precise. (e.g., "We will use the `@inertiajs/vite` plugin and remove Axios.")

## Consequences
**Positive:**
* [Benefit 1]
* [Benefit 2]

**Negative (Trade-offs):**
* [Cost/Risk 1]
* [Cost/Risk 2]

Template 2: RAG-Optimized llms.txt

Use this when creating an AI-readable index for a repository.

# [Project Name] - LLM Context

> Brief, one-sentence description of the project stack and purpose.

## Core Architecture
* **Frontend:** [e.g., React 19, Expo]
* **Backend:** [e.g., Laravel 12, PHP 8.5]
* **State/Data:** [e.g., Inertia v3, Convex]

## Directory Structure Guide
* `/src/actions` - Single-responsibility business logic.
* `/src/components` - UI components (No data fetching here).

## Hard Rules (Do Not Violate)
1. [e.g., Never use React Context for translations; use the event emitter hook.]
2. [e.g., Never write 'Fat Controllers'.]

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.