code-annotate

Insert implements annotations after function headers in Python, JavaScript/TypeScript, Go, and Rust.

41|6|Updated Jul 12, 2025
One-click install
npx skills add https://github.com/SteveGJones/ai-first-sdlc-practices --skill code-annotate
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-annotate
Source: https://github.com/SteveGJones/ai-first-sdlc-practices/tree/main/plugins/sdlc-assured/skills/code-annotate
Command: npx skills add https://github.com/SteveGJones/ai-first-sdlc-practices --skill code-annotate

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate boilerplate # implements: annotation for a function based on the artefact ID, inserting it as the first line of the function body.

Core Features & Use Cases

  • Automatically inserts the correct implements annotation based on the artefact-id, ensuring traceability between code and design/requirements.
  • Validates that the artefact-id exists in library/_ids.md prior to insertion and uses the proper language-specific comment syntax.
  • Supports common languages (Python, JavaScript/TypeScript, Go, Rust) and places the annotation immediately after the function header.

Quick Start

Annotate the active function by inserting the correct '# implements: <artefact-id>' line as the first line inside the function body.

Frequently Asked Questions about code-annotate

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

FAQPage Schema
How do I automatically insert implements annotations into source code?▼

To insert implements annotations automatically, the Skill places a linked artefact tag as the first line inside a function body, using language-specific comment syntax to maintain traceability between code and design requirements.

Does this code annotation tool support Python, JavaScript, and Go?▼

Yes, this code annotation tool supports Python, JavaScript, TypeScript, Go, and Rust. It detects the specific language context and applies the correct comment syntax immediately after the function header.

How do I validate an artefact ID before adding an implements comment?▼

To validate an artefact ID before adding an implements comment, the Skill checks the library/_ids.md file to verify the artefact exists, then performs an integrity check to ensure the annotation format is correct.

What is the purpose of linking an artefact ID in a function body?▼

Linking an artefact ID in a function body generates boilerplate implements annotations that establish direct traceability between your source code and its corresponding design or requirements artefacts.

Can I use this to add code annotations for TypeScript files?▼

Yes, you can use this to add code annotations for TypeScript files. The Skill detects JavaScript and TypeScript editing contexts, automatically applying the correct comment syntax to insert the implements tag.