note-it

Document design decisions, deviations, tradeoffs, and open questions for a completed issue as HTML.

207|30|Updated May 16, 2026
One-click install
npx skills add https://github.com/smallnest/goal-workflow --skill note-it
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: note-it
Source: https://github.com/smallnest/goal-workflow/tree/main/skills/note-it
Command: npx skills add https://github.com/smallnest/goal-workflow --skill note-it

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams preserve the reasoning behind implemented code so important context is not lost after an issue is built and reviewed. It turns ad hoc notes into a consistent HTML record that explains what changed, why it changed, and what still needs follow-up.

Core Features & Use Cases

  • Implementation Notes Capture: Records design decisions, deviations, tradeoffs, and open questions for a specific issue.
  • Pre-ship Documentation: Creates a structured checkpoint before shipping so reviewers can quickly understand non-obvious choices.
  • Use Case: After finishing an issue and running review fixes, generate a notes page that explains the implementation approach and highlights any spec gaps or future questions.

Quick Start

Ask the skill to create implementation notes for the current issue and save them as an HTML file in docs with the required issue number.

Frequently Asked Questions about note-it

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document implementation rationale before shipping code?

To document implementation rationale before shipping, you capture design decisions, deviations, tradeoffs, and open questions for a completed issue. This creates a structured HTML record explaining what changed and why it changed for reviewers.

What is the best way to record design decisions and tradeoffs for issue tracking?

Recording design decisions and tradeoffs for issue tracking involves documenting the implementation approach and highlighting spec gaps or future questions. This preserves the reasoning behind implemented code so important context is not lost after review.

How do I generate HTML implementation notes for a specific issue number?

To generate HTML implementation notes, you resolve the issue number and use a fixed four-section template. The skill outputs the final rationale record as an HTML file located at docs/issue#XXXX.html.

Can I create pre-ship documentation for issue-driven development workflows?

Yes, you can create pre-ship documentation for issue-driven development workflows. It generates a structured checkpoint after implementation and review fixes, allowing reviewers to quickly understand non-obvious choices before the code ships.

Does this approach require a completed code review before generating implementation notes?

Yes, generating implementation notes requires the issue implementation to be already reviewed. It applies to workflows where review fixes are finished and a final rationale record is needed to document deviations and open questions before shipping.

Why are my implementation notes not capturing the correct design decisions?

Implementation notes fail to capture design decisions when they lack a structured template. Using a fixed four-section format ensures you consistently record deviations, tradeoffs, and open questions tied to the specific issue number.