annotate

Read inline annotations in plan.md and update the plan document.

Updated Aug 14, 2024
One-click install
npx skills add https://github.com/kokatsu/dotfiles --skill annotate-kokatsu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: annotate
Source: https://github.com/kokatsu/dotfiles/tree/main/.config/claude/skills/annotate
Command: npx skills add https://github.com/kokatsu/dotfiles --skill annotate-kokatsu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Read user's inline notes in plan.md and update the plan accordingly without implementing any code.

Core Features & Use Cases

  • Identifies user-added inline annotations within plan.md (e.g., lines starting with > or keywords like NOTE:, TODO:, FIX ME:, or markers such as <!-- --> and [[ ]]).

  • Updates the plan.md content to reflect feedback while removing annotation markers.

  • Maintains the original plan structure and the todo list, ensuring changes are traceable without executing code.

Quick Start

Read plan.md, identify inline annotations, and update the plan accordingly without implementing any code.

Frequently Asked Questions about annotate

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

FAQPage Schema
How do I update a plan.md file from inline notes without writing code?

To update plan.md from inline notes without coding, use a tool that reads annotations like NOTE:, TODO:, FIXME:, blockquotes, or HTML comments, then applies those notes directly to the document while removing the markers.

What annotation markers can be parsed and removed from markdown documentation?

Markdown annotation markers that can be parsed and removed include lines starting with >, keywords like NOTE:, TODO:, FIXME:, and markup tags such as <!-- --> and [[ ]]. The tool updates content based on these markers and deletes them.

Can I incorporate TODO and FIXME comments into my project plan automatically?

Yes, you can incorporate TODO and FIXME comments into your project plan automatically by processing plan.md with an annotation parser that integrates the feedback into the main text and strips the original comment syntax.

Does the inline note processing tool modify the original todo list structure?

No, the inline note processing tool maintains the original plan structure and todo list. It only updates the document content to reflect the annotations and provides a concise summary of the applied changes.

What is the best way to clean up markdown annotations while preserving the document plan?

The best way to clean up markdown annotations while preserving the document plan is to use an automated parser that identifies markup comments and blockquotes, integrates the feedback, and outputs a concise summary of the changes.