# Keep Repository Documentation Current

Code changes often leave README files, changelogs, and docstrings outdated. This skill reviews implementation changes and updates affected documentation using repository conventions.

## Install

```bash
npx skillstore add consiliency/post-impl-docs
```

## Metadata

- Status: approved
- Slug: consiliency-post-impl-docs
- Skillstore revision: r1
- Version status: missing
- Tree hash: 8786269dece7b28b5656b40a7ef04479a576a69b61fdfa3768dcb8e166214c52
- Author: Consiliency
- GitHub username: Consiliency
- License: MIT
- Repository: https://github.com/Consiliency/treesitter-chunker/tree/main/.ai-dev-kit/skills/post-impl-docs
- Ref: 635f69fb8d2f4e6330ba47a4e5a0fb239c04d110
- Supported tools: Claude, Codex, Claude Code
- Audit status: complete
- Agent install advisory: allowed
- Manual install advisory: allowed
- Artifact signature: available
- Audit attestation: unavailable
- Human verification: not\_verified
- Risk factors: external\_commands, network, env\_access
- Quality score: 78
- Quality tier: bronze
- Public page: https://skillstore.pages.dev/skills/consiliency-post-impl-docs
- Manifest: https://skillstore.pages.dev/api/skills/consiliency-post-impl-docs/manifest

## Capabilities

- Reviews Git changes to identify documentation impact.
- Updates README sections for public features, APIs, installation changes, and breaking changes.
- Adds changelog entries in conventional, Keep a Changelog, or simple formats.
- Revises docs references and inline docstrings for changed symbols, parameters, returns, errors, and examples.
- Produces structured reports for completed updates or changes with no documentation impact.

## Use Cases

- Document a completed feature: Update README sections, changelog entries, reference pages, and docstrings after adding a public feature.
- Prepare a pull request: Review implementation changes and make affected documentation consistent before opening or merging a pull request.
- Standardize documentation workflows: Apply shared changelog and docstring conventions after automated implementation tasks.

## Prompt Templates

### Update documentation for one change

```
Review the latest implementation diff. Update only the README, changelog, docs, and docstrings affected by the change. Summarize every edit.
```

### Refresh API documentation

```
Compare the changed public API with current documentation. Update signatures, parameters, return values, errors, and examples while preserving repository style. Report unresolved gaps.
```

### Document a breaking release

```
Document the breaking change between [base_ref] and [head_ref]. Update usage examples, migration guidance, deprecation notes, docstrings, and the changelog. Identify references needing manual review.
```

### Audit documentation across a release

```
Audit documentation for all changes between [base_ref] and [head_ref]. Review README, changelog, docs, and docstrings. Apply evidence-supported updates and run available documentation checks. Return a file-by-file impact summary.
```

## Limitations

- Depends on accurate repository diffs and existing documentation.
- Does not validate implementation correctness or decide release readiness.
- Command examples assume Git and language-specific tools are installed.
- Generated documentation and automated changelog entries require human review.

## Best Practices

- Review the implementation diff before editing documentation.
- Match existing repository structure, terminology, and formatting.
- Run relevant documentation tests and inspect the final diff.

## Anti Patterns

- Do not document internal refactors as public features.
- Do not replace verified examples with untested assumptions.
- Do not add changelog entries for formatting-only or documentation-only changes.

## Security Audit

- Audited at: 2026-07-13T16:47:27.006\+00:00
- Summary: All 79 static findings are false positives caused by Markdown syntax, public documentation links, a placeholder credential, and exception text. The documented commands support repository inspection and documentation checks, with no hidden execution, credential access, exfiltration, or prompt injection. Users should still review generated documentation changes before committing them.

## Stats

- Views: 201
- Downloads: 7
- Favorites: 0
- Popularity score: 0