agentleFS
youmissedaspotyoumissedaspot/ymas-agent-workflows/skills/documentation-consolidation/SKILL.md

documentation-consolidation

Skill1 starsChanged 46 days agoMITView on GitHub

Migrate or consolidate the current repository's existing documentation into an adapted YMAS workflow when the user requests it. Bare invocation authorizes preserve-mode consolidation of the current repository; cleanup requires explicit intent. Do not infer deletion permission or authority from apparent duplication.

The file

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 4 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Before changing files, inspect existing conventions, authority, filenames/directories, agent instructions (including established casing), …

    line 12
  2. Distinctive:

    Before removing each obsolete duplicate, establish that:

    line 31
  3. Distinctive:

    If any condition is uncertain, preserve the file.

    line 39
  4. Distinctive:

    Use human explanation and editorial judgment for readable explanations and documentation.

    line 51

≈ “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

Documentation consolidation

Use for an explicitly requested documentation migration or consolidation. Bare $documentation-consolidation targets the current repository in preserve mode. A natural-language consolidation request is sufficient; no special command is required. If the current repository is unclear, ask which one. A request only to assess fit belongs to evaluate-repository.

Establish the migration boundary

Before changing files, inspect existing conventions, authority, filenames/directories, agent instructions (including established casing), document IDs, Git status, and any migration already underway. Read relevant history to understand intentional structure. Preserve unrelated work and follow the repository's branch rules.

Identify the existing owner for each subject and adapt the YMAS method to that repository. Do not impose YMAS through an unrelated task or create a competing documentation system. Explicit invocation authorizes this adaptation, subject to local authority; it does not authorize inventing product rules or deciding contested precedence.

Make a concrete source-to-destination map for the requested scope: documents to retain, move, consolidate, cross-reference, or archive, with reasons and authority sources. Resolve routine placement using established rules. Leave ambiguous material intact and ask the owner only about decisions that block the affected changes; continue independent, authorized work.

Preserve mode — default

  • Establish or update the repository's own documentation standard and concise agent-instruction pointers using project-bootstrap and its adaptable template. Preserve stronger or equivalent existing rules and filenames; do not copy a universal hierarchy into the project.
  • Map existing content into appropriate owners/families and reuse established IDs and retrieval categories. Do not rename valid legacy records just to match a newer convention. Update an existing owner before creating another document; create operational records only for meaningful transitions, decisions, or current state supported by evidence.
  • Apply the repository's documentation standard and document versioning to substantive owner revisions. Sequence IDs are not versions: preserve each owner's ID and stable current path, record the later dotted version as metadata, and archive the complete predecessor before replacing it. Derive the archive suffix from the predecessor: an old Version: v3.1 uses _v3dot1.md. Keep the newer version in the current functional folder; do not archive it or leave multiple current revisions. Preserve unrelated legacy filenames and version conventions.
  • Preserve the specification workflow: conversation and settled decisions → authoritative specification documents → integrated systems.md. Keep sibling SPEC/SPECARC definitions distinct from ADR decision rationale, the adopted SYS role, and the whole-set map. Preserve their independent IDs; do not rename one family into another or force an early map before useful integration is possible. Do not consolidate the map into an upstream requirements owner or rewrite settled decisions to preserve old architecture. If the authorized migration materially revises specifications, review the entire current set and update the map for changes to architecture, ownership, boundaries, dependencies, interfaces, flows, or cross-system behavior; organization alone does not authorize new product or architecture decisions.
  • Consolidate duplicate guidance in a clear current owner while retaining source material or archiving it with a historical label and a reference to its current owner. Preserve unique qualifications, rationale, decision evidence, and historical context. Do not replace a source with a stub that discards its information in preserve mode.
  • Move clearly superseded material to the project's archive only when its status and ownership are understood and the move is permitted. Preserve IDs and traceability; ordinary moves retain filenames, while superseded revisions gain the old-version suffix under the versioning rules. Update links and indexes affected by approved moves. Do not destructively remove historical information.

Cleanup mode — explicit only

$documentation-consolidation cleanup or a clear request to remove superseded material enables cleanup within that scope. Requests to organize, tidy, evaluate, or consolidate alone do not enable it. No additional confirmation is required solely because cleanup mode was explicitly requested; honor any actual project approval requirements.

Before removing each obsolete duplicate, establish that:

  • its information is preserved in the correct owner;
  • its authority and supersession are understood;
  • incoming references are updated;
  • Git contains the removed content and provides a known recovery commit;
  • removal loses no unique historical or decision evidence.

If any condition is uncertain, preserve the file. Untracked or uncommitted content has no guaranteed Git recovery; do not delete it on the assumption that history will recover it. Cleanup is not permission to discard unresolved conflicts or unrelated files.

Retrieval and verification

By default, for new YMAS records use <FAMILY>_<L2_CATEGORY>_<ID>_<l3-description>.md: underscores separate structural segments; lowercase hyphens separate description words. Reuse one stable, canonical uppercase Level 2 token per domain across families. Avoid synonyms, alternate plurals, arbitrary abbreviations, and overlapping categories unless established locally. Level 2 is a retrieval dimension, not a sequence: allocate IDs family-wide across current, archived, and legacy locations unless project authority explicitly says otherwise. Never turn roadmap, milestone, phase, sprint, release, or temporary planning labels into durable taxonomy. Use the adopting project's vocabulary, not a product-specific taxonomy supplied by this package.

OPS_NEXT alone uses OPS_NEXT_<ID>_<L2_CATEGORY>_<l3-description>.md for new records, including those created during consolidation. This intentional exception prioritizes chronological/current-action retrieval while other families prioritize domain retrieval; both keep Level 2 classification. Preserve its one family-wide sequence across categories, with the highest numeric ID defining the current recommended next action unless project authority explicitly says otherwise. Account for legacy locations and category-first historical names when finding that ID. Do not normalize sequence-first names back to the default ordering, restart numbering by category, reuse IDs, or renumber existing records. Do not mass-rename historical OPS_NEXT files solely for conformity unless the migration explicitly includes filename normalization; such moves must preserve IDs, history, and references. Do not introduce other ordering exceptions without a similarly clear retrieval reason.

Verify the scoped diff against the migration map, document IDs, content preservation, references/indexes, and stale paths. Use before/after hashes for content-preserving moves; for intentional consolidation, account for each source's unique information and retained historical location. Preserve mode must have no unexplained loss; cleanup must have recovery evidence for each removal. Run applicable documentation/package checks.

Report the mode used, files changed, owners established, preserved/archived material, any deletions with recovery commits, verification results, unresolved questions, and the next action. Keep recommendations separate from completed changes and product authority separate from organizational decisions.

Use human explanation and editorial judgment for readable explanations and documentation. Consider ordinary documentation purposes only where useful; do not reclassify canonical specifications or infer migration authority from editorial guidance.

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.