Add /document-feature slash command - #21
Open
andre-crator wants to merge 1 commit into
Open
Conversation
Generates paired documentation for an existing feature: a technical write-up (files involved, data flow, API, data models, tests) in docs/dev/, and a plain-language user guide with step-by-step instructions and screenshot placeholders in docs/user/. Locates the feature by searching the codebase for it first, and asks for clarification instead of inventing content when nothing matches. Also updates the README with a Commands table and install/usage instructions, since it only had a one-line title before.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
/document-feature, a slash command that generates paired documentation for an existing feature in a project:docs/dev/<slug>-implementation.md— technical write-up: overview, files involved (with paths/line refs), architecture and data flow, API/interfaces, data models, implementation notes, dependencies, and tests.docs/user/how-to-<slug>.md— plain-language user guide: what the feature does, step-by-step instructions with[SCREENSHOT: ...]placeholders at each state change, and a troubleshooting section sourced from real error messages in the code.Key behaviors:
Glob/Grep) for the feature before writing anything — if nothing matches, it stops, lists what it searched for, suggests partial matches if any, and asks the user instead of inventing content.docs/dev/,docs/user/, or a style guide) if present.Also updates
README.md(previously just a one-line title) with aCommandstable and install/usage instructions, so the command is discoverable.Test plan