note-it

Featured

Capture implementation notes after code implementation and review/fix. Records design decisions, deviations, tradeoffs, and open questions to docs/issue#XXXX.html. Triggers on: /note-it, 记录笔记, implementation notes.

Web & Frontend 235 stars 32 forks Updated 5 days ago MIT

Install

View on GitHub

Quality Score: 92/100

Stars 20%
79
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Implementation Notes After completing implementation and review/fix for an Issue, capture a running implementation notes file that documents how the implementation diverges from or interprets the spec. ## Triggers Use when: - After `/goal` implementation and `/review-it` are both complete - User says "记录笔记", "implementation notes", "note-it", "/note-it" - Before `/ship-it` (as a final checkpoint) - Any time the user wants to capture design rationale ## The Job 1. Determine the Issue number from context (branch name, `/goal` target, or user input) 2. Review the implementation against the Issue spec / PRD 3. Generate an HTML notes file at `docs/issue#XXXX.html` 4. Present a summary to the user ## Notes Structure The HTML file must cover these four categories. If a category has nothing to report, write "None" with a brief explanation. ### 1. Design Decisions Choices made where the spec was ambiguous or silent: - What was the ambiguity? - What choice did you make? - What was the rationale? ### 2. Deviations Places where you intentionally departed from the spec: - What did the spec say? - What did you implement instead? - Why was the deviation necessary or better? ### 3. Tradeoffs Alternatives you considered and why you picked what you did: - What were the viable alternatives? - What were the pros/cons of each? - Why did the chosen approach win? ### 4. Open Questions Anything you'd want confirmed or revised: - What assumption are you unsure about? - What should the us...

Details

Author
smallnest
Repository
smallnest/goal-workflow
Created
3 months ago
Last Updated
5 days ago
Language
HTML
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category