update-notes

Capture non-obvious engineering insights into project-scoped notes and regenerate INDEX.md.

2|1|Updated Sep 28, 2023
One-click install
npx skills add https://github.com/vmasrani/dotfiles --skill update-notes
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-notes
Source: https://github.com/vmasrani/dotfiles/tree/main/maintained_global_claude/skills/update-notes
Command: npx skills add https://github.com/vmasrani/dotfiles --skill update-notes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Capture non-obvious engineering truths about a codebase into a project-scoped knowledge base, preserving institutional memory across lifecycles.

Core Features & Use Cases

  • Project-scoped notes: store non-obvious engineering insights in the project’s .notes/ directory with stable slugs.
  • Automated indexing: regenerate INDEX.md after each run to reflect new or updated notes.
  • Cross-linking and categorization: connect notes via related: and categorize them into defined seeds like api-surface, architecture, gotchas, or conventions.
  • Idempotent runs: safe to run repeatedly without duplicating content.

Quick Start

Run the update-notes command to seed and refresh the project's notes index.

Frequently Asked Questions about update-notes

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

FAQPage Schema
How do I capture non-obvious engineering insights about a codebase into a knowledge base?▼

To capture engineering insights, you can use a zettelkasten approach that stores non-obvious codebase findings in a project-scoped .notes/ directory. This preserves institutional memory by automatically indexing and categorizing durable engineering truths across the project lifecycle.

What is the best way to maintain codebase notes without creating duplicates over time?▼

The best way to maintain codebase notes without duplicates is using an idempotent knowledge-management process. By enforcing stable slugs for each note, the system ensures safe repeated runs that update existing entries rather than generating duplicate files.

How does automated indexing work for a project-scoped zettelkasten?▼

Automated indexing for a project-scoped zettelkasten works by regenerating an INDEX.md file after each update. This reflects new or modified notes across the project lifetime, ensuring the knowledge base remains navigable and up-to-date without manual curation.

Can I categorize engineering notes and cross-link related codebase findings?▼

Yes, you can categorize engineering notes and cross-link related codebase findings. Notes support cross-linking via related fields and can be organized into predefined seeds like api-surface, architecture, gotchas, or conventions to structure your knowledge effectively.

What types of engineering findings should be stored in a project knowledge base?▼

Only non-obvious engineering findings should be stored in a project knowledge base. The system explicitly rejects trivial observations, focusing instead on durable truths, architectural decisions, and hidden gotchas that preserve genuine institutional memory.

Does update-notes require external dependencies to manage codebase notes?▼

No, update-notes does not require external dependencies to manage codebase notes. It operates independently to write findings into the .notes/ directory and regenerate the INDEX.md file, requiring no prior environment setup or package installations.