agentleFS
nerymurillohndnerymurillohnd/the-claude-factory/.claude/skills/docs-maintenance/SKILL.md

docs-maintenance

Skill1 starsChanged yesterdayMITView on GitHub

Writes, updates and audits The Claude Factory's documents from their templates, such as each plugin's README.md, CHANGELOG.md, LICENSE and NOTICE.txt, the root README.md and CHANGELOG.md, and the root policy files (CODE_OF_CONDUCT, CONTRIBUTING, SECURITY, SUPPORT, PRIVACY). Use before and while creating, editing, reviewing or auditing any of these documents, and whenever another skill says to write a document with it, even for a one-line fix.

6 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 4 edited versions we read keep these.

  • 2

    Distinctive

    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:

    Read governance.md in full: the values only the owner can give, the checks, and the conventions every document follows.

    line 34
  2. Distinctive:

    Write the document, then run the checks in its procedure and in governance.md, and show their raw output.

    line 37

“Common” is measured: kept by at least 6 in 10 of the 4 edited versions of this file we could read. “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

Docs maintenance

Everything these documents say reaches third parties: a plugin's README tells a stranger what runs on their machine, a changelog tells them what an update breaks, and a license or a notice carries legal terms. Each document has a fill procedure and a template here, checked against the official sources, so that every document comes out the same way whoever writes it. Write each one from its procedure and its template, never from memory.

Who writes

  • You write the documents, following the procedure and the template in the table below.
  • The one exception is a plugin README written in full for the first time, such as a new plugin's: launch the plugin-readme-writer subagent for it, because the README is long, has many rules, and benefits from its own context. Brief it as governance.md says. Where no subagent is available, as in a cloud thread of a Claude Project, write it yourself from the same procedure.
  • Versions, change types, renames, removals and releases are decided by the plugin-releases and plugin-catalog-changes skills. They call this skill for the documents they need; take their decisions as given.

Documents

DocumentProcedureTemplate
plugins/<plugin>/CHANGELOG.mdchangelog.mdCHANGELOG-template.md
Root CHANGELOG.mdmarketplace-changelog.mdmarketplace-changelog-template.md
plugins/<plugin>/README.mdplugin-readme.mdplugin-readme-template.md
Root README.mdroot-readme.mdroot-readme-template.md
Root and plugin LICENSElicense.mdLICENSE-template.md
plugins/<plugin>/NOTICE.txtnotice.mdNOTICE-template.md
CODE_OF_CONDUCT.mdcode-of-conduct.mdCODE_OF_CONDUCT-template.md
CONTRIBUTING.mdcontributing.mdCONTRIBUTING-template.md
SECURITY.mdsecurity.mdSECURITY-template.md
SUPPORT.mdsupport.mdSUPPORT-template.md
PRIVACY.mdprivacy.mdPRIVACY-template.md

How to write a document

  1. Read governance.md in full: the values only the owner can give, the checks, and the conventions every document follows.
  2. Read the document's procedure in full, then its template. Each procedure says what the document produces, its sources, what each placeholder means and where its true value comes from, its rules and its checks. When another skill called you for one task, apply the procedure step that matches it (for example, a release: changelog.md step 4) and say which step you applied.
  3. Take every value from the repository's files, the calling skill's decisions or the owner. Ask the owner for a value only the owner can give; never invent one.
  4. Write the document, then run the checks in its procedure and in governance.md, and show their raw output.

Events that call for documents

The changes the lifecycle skills handle (a plugin change, a new version, a rename, a removal, a withdrawn version) start from those skills. These other events start here; read the event's file and follow it:

EventIt applies whenReference
Repository foundationThe repository's own documents are created or rebuiltrepository-foundation.md
New pluginA plugin directory with its plugin.json appears and is listed in marketplace.jsonnew-plugin.md
Third-party material changesAnother author's material is added to a plugin, updated or removedthird-party-material.md
Data handling changesA plugin starts or stops calling a remote service, collecting data or keeping files on the user's machinedata-handling.md
The owner changes a policyA copyright line, reporting channel, security policy, support channel or contribution process changespolicy-change.md
Audit or reviewSomeone asks whether the documentation is correct, or drift is suspectedaudit.md
A small fixA typo, a broken link or an outdated sentencesmall-fix.md

commands.md says what each documentation command checks and what it doesn't.

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.