doc-closeout

Name: doc-closeout
Author: Snowmnason

Start the docs agent to write issue closeout docs, update top-level module READMEs, or suggest a deeper technical note

by Snowmnason(0) 0 installs

Free

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Prompt file imported from Snowmnason/dnd-toolkit (.github/prompts/doc-closeout.prompt.md). Copyright stays with the author.

Use docs.agent.md to update documentation after implementation.

Working rules:

Use issue closeout mode for docs/issues/** deliverables.
Always create or update USAGE_GUIDE.md and IMPLEMENTATION.md for issue closeout work.
Use README mode for top-level module READMEs in lib/*, hooks/*, and system/*.
Do not create nested module READMEs unless the user explicitly asked for one.
Suggest a deep note when a pipeline or cross-module flow needs more detail, but ask before creating a new file under docs/Important Notes/**.
Do not implement code or write tests in this workflow.

Deliver:

the requested docs update
any optional doc suggestion that needs approval
any missing source context needed to finish the documentation cleanly

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

Use [docs.agent.md](../agents/docs.agent.md) to update documentation after implementation.

Working rules:

- Use issue closeout mode for `docs/issues/**` deliverables.
- Always create or update `USAGE_GUIDE.md` and `IMPLEMENTATION.md` for issue closeout work.
- Use README mode for top-level module READMEs in `lib/*`, `hooks/*`, and `system/*`.
- Do not create nested module READMEs unless the user explicitly asked for one.
- Suggest a deep note when a pipeline or cross-module flow needs more detail, but ask before creating a new file under `docs/Important Notes/**`.
- Do not implement code or write tests in this workflow.

Deliver:

- the requested docs update
- any optional doc suggestion that needs approval
- any missing source context needed to finish the documentation cleanly

Manifest

The prompt text and its fill-in variables. Copy it or fetch it by URL from your own code.

snowmnason-dnd-toolkit-doc-closeout-prompt.prompt.jsonjson

{
  "prompt": "Use [docs.agent.md](../agents/docs.agent.md) to update documentation after implementation.\n\nWorking rules:\n\n- Use issue closeout mode for `docs/issues/**` deliverables.\n- Always create or update `USAGE_GUIDE.md` and `IMPLEMENTATION.md` for issue closeout work.\n- Use README mode for top-level module READMEs in `lib/*`, `hooks/*`, and `system/*`.\n- Do not create nested module READMEs unless the user explicitly asked for one.\n- Suggest a deep note when a pipeline or cross-module flow needs more detail, but ask before creating a new file under `docs/Important Notes/**`.\n- Do not implement code or write tests in this workflow.\n\nDeliver:\n\n- the requested docs update\n- any optional doc suggestion that needs approval\n- any missing source context needed to finish the documentation cleanly",
  "variables": [],
  "notes": "Start the docs agent to write issue closeout docs, update top-level module READMEs, or suggest a deeper technical note Arguments: Point to the issue file, touched modules, or documentation target to update.",
  "metadata": {
    "source": {
      "provider": "github-prompts",
      "repository": "https://github.com/Snowmnason/dnd-toolkit",
      "path": ".github/prompts/doc-closeout.prompt.md",
      "ref": "d3f2e55e326307ee4e91577c12955c14b429150b",
      "url": "https://github.com/Snowmnason/dnd-toolkit/blob/d3f2e55e326307ee4e91577c12955c14b429150b/.github/prompts/doc-closeout.prompt.md",
      "key": "Snowmnason/dnd-toolkit/.github/prompts/doc-closeout.prompt.md"
    }
  }
}

Fetch it by URL: GET /api/v1/registry/snowmnason-dnd-toolkit-doc-closeout-prompt/manifest?version=1.0.0

About

Use it

Manifest

Reviews