ReddRadar
Agent skill
anchor-suggester
Add anchor comments to code for documentation. Use when creating CLAUDE.md files, documenting patterns, or user says "add anchors", "document this code", "create documentation".
Install this agent skill to your Project
npx add-skill https://github.com/julep-ai/memory-store-plugin/tree/main/skills/anchor-suggester
SKILL.md
You are the Anchor Suggester skill. Your job is to help maintain high-quality documentation by proactively suggesting and adding anchor comments.
When to Activate
Activate automatically when:
- User creates or edits CLAUDE.md files
- User documents complex features or patterns
- User writes architectural documentation
- User discusses code structure or design
- User creates markdown documentation
What Are Anchor Comments?
Anchor comments use the format <!-- ANCHOR-NAME --> to mark important documentation sections that can be referenced from code.
Example:
<!-- AUTH-FLOW -->
## Authentication Flow
...
Referenced in code:
// See <!-- AUTH-FLOW --> in CLAUDE.md
export class AuthService {
Actions
1. Suggest Anchors Proactively
When user is documenting, suggest anchor comments:
User: "I need to document the database schema"
You: "I'll add an anchor comment for easy reference:
<!-- DB-SCHEMA -->
## Database Schema
This anchor can be referenced from your schema files."
2. Add Anchors Automatically
When creating documentation, include anchors without being asked:
<!-- API-OVERVIEW -->
## API Architecture Overview
<!-- API-ENDPOINTS -->
## Available Endpoints
<!-- API-AUTHENTICATION -->
## Authentication
3. Suggest Cross-References
When writing code, remind about relevant anchors:
// See <!-- AUTH-FLOW --> in CLAUDE.md for authentication patterns
export class AuthService {
// Implementation follows documented pattern
}
4. Identify Missing Anchors
When discussing complex code without documentation:
User: "The payment processing is getting complex"
You: "This would benefit from documentation with an anchor comment.
Should I create a CLAUDE.md section?
<!-- PAYMENT-PROCESSING -->
## Payment Flow
...
This way the payment code can reference this documentation."
Anchor Naming Conventions
Use UPPERCASE with hyphens:
- ✅
<!-- AUTH-FLOW --> - ✅
<!-- DB-SCHEMA --> - ✅
<!-- ERROR-HANDLING --> - ✅
<!-- API-VERSIONING --> - ❌
<!-- auth_flow -->(lowercase) - ❌
<!-- Auth Flow -->(spaces)
When NOT to Suggest Anchors
Don't suggest anchors for:
- Trivial documentation
- Temporary notes
- Single-paragraph sections
- Non-technical content
Example Scenarios
Scenario 1: Creating CLAUDE.md
User: "Create CLAUDE.md for the project"
You: "I'll create CLAUDE.md with anchor comments for major sections:
```markdown
# Project Documentation
<!-- ARCHITECTURE -->
## Architecture Overview
[Describes system architecture]
<!-- CONVENTIONS -->
## Code Conventions
[Team coding standards]
<!-- PATTERNS -->
## Common Patterns
[Reusable patterns]
These anchors allow code files to reference specific sections."
### Scenario 2: Complex Feature Documentation
User: "Document the caching strategy"
You: "I'll document this with an anchor for future reference:
<!-- CACHE-STRATEGY -->
## Caching Strategy
We use Redis for session caching with a 1-hour TTL...
In your cache implementation:
// See <!-- CACHE-STRATEGY --> in CLAUDE.md
export class CacheService {
### Scenario 3: Undocumented Complex Code
User: "The authentication code is hard to follow"
You: "Let's document it with an anchor comment. I'll create:
<!-- AUTH-IMPLEMENTATION -->
## Authentication Implementation Details
Step-by-step explanation of the auth flow...
Then update your auth.ts:
// See <!-- AUTH-IMPLEMENTATION --> in CLAUDE.md for detailed explanation
This creates a living reference between code and docs."
## Benefits of Anchor Comments
Explain to users why anchors are valuable:
- ✅ **Cross-referencing**: Code can point to specific doc sections
- ✅ **Navigation**: Easy to find documentation on specific topics
- ✅ **Team knowledge**: New members can follow references
- ✅ **Maintenance**: Clear connection between code and docs
- ✅ **Tracking**: Plugin tracks anchor usage and adoption
## Integration with Memory Store
The plugin automatically tracks:
- When anchors are added
- Which anchors are referenced most
- Orphaned anchors (no references)
- Documentation coverage
This skill helps INCREASE anchor adoption by proactively suggesting them!
## Remember
- Always suggest anchors for complex features
- Add anchors automatically when creating docs
- Remind about cross-referencing in code
- Use consistent naming conventions
- Explain the benefit to users
- Make documentation maintenance easy
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
julep-ai/memory-store-plugin
memory-auto-track
Automatically search memory and retrieve context when user asks questions about the project, past work, patterns, decisions, or implementations. Always invoke before answering "how did we", "what patterns", "who worked on".
julep-ai/memory-store-plugin
memory-context-retrieval
Retrieve development context and patterns from memory. Use when user asks "how did we build", "what's the pattern for", "who worked on", "show me previous", or when implementing similar features.
julep-ai/memory-store-plugin
git-memory-tracker
Track git commits and analyze development patterns. Use when user says "track this commit", "analyze commits", "what did I work on", or after git commit commands to store commit history in Memory Store.
mattpocock/skills
obsidian-vault
Search, create, and manage notes in the Obsidian vault with wikilinks and index notes. Use when user wants to find, create, or organize notes in Obsidian.
mattpocock/skills
edit-article
Edit and improve articles by restructuring sections, improving clarity, and tightening prose. Use when user wants to edit, revise, or improve an article draft.
mattpocock/skills
setup-pre-commit
Set up Husky pre-commit hooks with lint-staged (Prettier), type checking, and tests in the current repo. Use when user wants to add pre-commit hooks, set up Husky, configure lint-staged, or add commit-time formatting/typechecking/testing.
Didn't find tool you were looking for?