identify-doc-code-disagreements
$
npx mdskill add imbue-ai/mngr/identify-doc-code-disagreementsDetects implementation mismatches between library docs and code.
- Finds functional conflicts where code behavior contradicts documentation.
- Reads library context files including non_issues.md for guidance.
- Ignores unfinished features and pre-existing FIXME markers.
- Reports specific discrepancies found in the codebase.
SKILL.md
.github/skills/identify-doc-code-disagreementsView on GitHub ↗
--- name: identify-doc-code-disagreements argument-hint: [library_name] description: Identify places in the $1 library where the docs and code disagree --- Go gather all the context for the $1 library (per instructions in CLAUDE.md). Be sure to read non_issues.md as well. Once you've gathered that context, please do the below (and commit when you're finished). Your task is to identify disagreements between the implementation and the documentation in the $1 library. In particular, focus on logical, meaningful conflicts between what is said in any written documentation and what is actually implemented in the code. Do NOT worry about functionality that is still clearly in-progress, under construction, etc--if something simply has not yet been implemented, that's ok. At most, you can suggest that the code be better about raising a NotImplementedError in such cases. We want to focus on issues where something actually *is* implemented, but it's not implemented *how* the docs say it should be. Do NOT worry other disagreements between really long, claude-generated "spec" files and the code (those are usually just left-over construction artifacts). If anything, you can simply highlight places where there was a big detailed spec that should have been deleted. Do NOT worry other types of issues besides conflicts between the docs and code. Do NOT report issues that are already covered by an existing FIXME Do NOT report issues that are highlighted as non-issues in non_issues.md After reviewing all the code in the library, think carefully about the most important disagreements between the docs and code. Then put them, in order from most important to least important, into a markdown file in the library's "_tasks/docs/" folder (make one if you have to) Name the file "<date>.md` (where you should get "date" by calling this precise command: "date +%Y-%m-%d-%T | tr : -") For the format of the file, use the following: ```markdown # Doc and code disagreements in the $1 library (identified on <date>) ## 1. <Short description of disagreement> Description: <detailed description of the disagreement, including file names and line numbers where applicable> Recommendation: <your recommendation for how to fix the disagreement> Decision: Accept ## 2. <Short description of disagreement> Description: <detailed description of the disagreement, including file names and line numbers where applicable> Recommendation: <your recommendation for how to fix the disagreement> Decision: Accept ... ``` There's no need to commit when you're done (these files are gitignored). Just be sure to create the file in the right location with the right content.
More from imbue-ai/mngr
- asciinema-demosCreate 1-3 short asciinema demo recordings (5-20 seconds each) that demonstrate completed work. Use only when explicitly instructed to create demos.
- convert-github-issues-to-fixmesConvert triaged autoclaude GitHub issues into FIXMEs in the codebase. Use when you want to process issues that have been triaged by authorized users.
- create-fixmesCreate FIXME's in the codebase for each of the issues in the given input file.
- create-github-issues-from-fileConvert a file containing identified issues into GitHub issues. Use after running identify-* commands to create corresponding GitHub issues.
- create-task-from-jsonCreate a prompt from a short task description in a JSON file
- fix-somethingFix a random FIXME in the codebase (in the given scope, use "." for the whole codebase)
- identify-inconsistenciesIdentify inconsistencies in the $1 library
- identify-outdated-docstringsIdentify outdated docstrings in the $1 library
- identify-style-issuesIdentify divergences from the style guide in the $1 library
- sync-tutorial-to-e2e-testsMatch tutorial script blocks to e2e pytest functions and add missing tests