Docs writer

About

Writes the README and setup docs from what the code actually does, and finds the instructions that stopped being true.

Files in v1.0.0

• replicamd.plugin.json2274 B
• skills/documentation-that-stays-true.md1990 B

Contributes

{
  "commands": [
    {
      "id": "audit",
      "title": "Find documentation that is no longer true",
      "prompt": "Read this project's README and setup docs, then check every factual claim against the code.\n\nGo through them in the order a newcomer would hit them: install steps, required versions, environment variables, the commands to run, build and test, deploy. For each, verify against the real source - the build manifest's scripts, the lockfile's engine constraints, what the code reads from the environment, the CI workflow.\n\nReport only what is wrong or missing, with the correct version: a command that was renamed, a variable that is required and undocumented, a step that silently no longer applies, a link that points at something that moved. Rank by how early a newcomer hits it, because a wrong first step costs more than a wrong last one.\n\nSay explicitly if the docs are accurate. \"I checked the setup steps and they work\" is a useful result."
    },
    {
      "id": "readme",
      "title": "Write the README this project deserves",
      "prompt": "Write or rewrite this project's README for someone who has just been handed the repository and needs to be useful today.\n\nOpen with what it is and who it is for, in two sentences, with no adjectives you cannot defend. Then: how to run it, how to run the tests, how the code is laid out, and the one or two things that would surprise a newcomer.\n\nEvery command must be one you found in the project, not one you assume is conventional. If the test command is unusual, that is exactly the thing worth writing down. Skip badges, skip a features list that restates the code, and skip a contributing section unless the project actually takes contributions.\n\nShow me the draft before writing the file."
    }
  ],
  "skills": [
    "skills/documentation-that-stays-true.md"
  ]
}

Versions

• v1.0.07/26/2026 · 2 files

Install

Nothing happened? ReplicaMD may not be installed yet - or open it first, then Settings → Plugins and install by id.

Plugin id:

Bundle endpoint: