Code Documentation for Traceability
CommunityLink code to requirements and risks.
Software Engineering#documentation#requirements#code comments#risk management#traceability#IEC 62304#ISO 14971
AuthorAminAlam
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill addresses the challenge of maintaining clear traceability between code, requirements, and risk controls, which is crucial for regulatory compliance and effective impact analysis in medical device development.
Core Features & Use Cases
- Traceability Tagging: Embeds stable IDs (e.g.,
REQ-###,RISK-CTRL-###) directly in code comments to link implementations to external artifacts. - API Documentation Standards: Enforces documentation for public interfaces, including purpose, parameters, ranges, and error codes.
- Use Case: When implementing a new safety feature, developers can add comments like
// REQ-123: Implement safety interlockto ensure the code is directly linked to the requirement, simplifying audits and future modifications.
Quick Start
Add traceability tags to the code comments for the function process_sensor_data.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: Code Documentation for Traceability Download link: https://github.com/AminAlam/meddev-agent-skills/archive/main.zip#code-documentation-for-traceability Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.