Skip to main content
Back to registry

create-oo-component-documentation

github/awesome-copilot

Create comprehensive documentation for the object-oriented component(s) at: ${input:ComponentPath} .

Installs7
Install command
npx skills add https://github.com/github/awesome-copilot --skill create-oo-component-documentation
Security audits
Gen Agent Trust HubPASS
SocketPASS
SnykPASS
About this skill
Create comprehensive documentation for the object-oriented component(s) at: ${input:ComponentPath} . Analyze the component by examining code in the provided path. If folder, analyze all source files. If single file, treat as main component and analyze related files in same directory. Generate well-structured Markdown with clear heading hierarchy, code blocks, tables, bullet points, and proper formatting for readability and maintainability. The documentation should be saved in the /docs/components/ directory and named according to the convention: [component-name]-documentation.md . The documentation file must follow the template below, ensuring that all sections are filled out appropriately. The front matter for the markdown should be structured correctly as per the example following: - DOC-001: Follow C4 Model documentation levels (Context, Containers, Components, Code) - DOC-002: Align with Arc42 software architecture documentation template - DOC-003: Comply with IEEE 1016 Software Design Description standard - DOC-004: Use Agile Documentation principles (just enough documentation that adds value) - DOC-005: Target developers and maintainers as primary audience - ANA-001: Determine path type (folder vs single file) and identify primary component - ANA-002: Examine source code files for class structures and inheritance - ANA-003: Identify design patterns and architectural...

Source description provided by the upstream skill listing. Community reviews and install context appear in the sections below.

Community Reviews

Latest reviews

Sign in to review

No community reviews yet. Be the first to review.

Browse this skill in context
FAQ
What does create-oo-component-documentation do?

Create comprehensive documentation for the object-oriented component(s) at: ${input:ComponentPath} .

Is create-oo-component-documentation good?

create-oo-component-documentation does not have approved reviews yet, so SkillJury cannot publish a community verdict.

What agent does create-oo-component-documentation work with?

create-oo-component-documentation currently lists compatibility with Agent compatibility has not been published yet..

What are alternatives to create-oo-component-documentation?

Skills in the same category include telegram-bot-builder, flutter-app-size, sharp-edges, iterative-retrieval.

How do I install create-oo-component-documentation?

npx skills add https://github.com/github/awesome-copilot --skill create-oo-component-documentation

Related skills

More from github/awesome-copilot

Related skills

Alternatives in Software Engineering