glossary

Extract domain-specific terms from code comments and documentation into GLOSSARY.md.

2|Updated Oct 17, 2024

Search Tags:#project management #documentation #codebase #glossary #terminology

Ready to run

npx skills add https://github.com/vadirn/nix --skill glossary-vadirn

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: glossary
Source: https://github.com/vadirn/nix/tree/main/home/agents/skills/glossary
Command: npx skills add https://github.com/vadirn/nix --skill glossary-vadirn

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps teams keep a consistent and accurate project glossary by automatically building and updating a list of domain terms.

Core Features & Use Cases

Glossary Maintenance: Creates and updates GLOSSARY.md with key domain terms as they appear in code comments and documentation.
Terminology Consistency: Ensures uniform terminology across the project, reducing misunderstandings.
Use Case: When developers discuss new features, the glossary helps clarify ambiguous terms by providing precise definitions grounded in the codebase.

Quick Start

Use the glossary skill to scan the codebase and update the project glossary to include newly identified terms.

Frequently Asked Questions about glossary

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

FAQPage Schema

How do I maintain a project glossary for consistent terminology across a codebase?▼

You can maintain a project glossary by automatically extracting domain-specific terms from code comments and documentation to generate a unified, alphabetically ordered list, ensuring consistent terminology across the codebase.

How does extracting domain terminology from code comments improve team communication?▼

Extracting domain terminology from code comments improves team communication by proposing definitive one-line definitions for ambiguous terms, grounding project discussions in the actual codebase to reduce misunderstandings.

What is the best way to document project terminology as new features are developed?▼

The best way to document project terminology is to scan the codebase for newly identified domain terms in code comments and documentation, then update the project glossary file with clear definitions.

Does this glossary generation approach avoid capturing generic or framework-related nouns?▼

Yes, glossary generation specifically avoids capturing generic or framework-related nouns, focusing instead on extracting domain-specific terms that have meaningful context within the project codebase.

Can I scan an entire codebase to build a unified list of domain-specific terms?▼

Yes, you can scan an entire codebase to analyze code patterns and extract key domain-specific terms, which are then compiled into a clear, unified project glossary for team reference.