Skip to content
C

create-oo-component-documentation

Create comprehensive, standardized documentation

by githubFree

Launch
#1928in AI Skills
0In stores

Description

create-oo-component-documentation is an agent skill from the github/awesome-copilot collection that writes standardized documentation for ob…

Highlights

  • Documents a file or a whole folder of components
  • C4 model levels for structure
  • Arc42 and IEEE 1016 alignment
  • Agile principle of documentation that adds value
  • Written for developers and maintainers
  • Installs with the skills CLI

Ratings & Reviews

No ratings yet

Be the first to rate create-oo-component-documentation.

People also visit

A

acquire-codebase-knowledge

The user explicitly asks to map, document, or onboard into an existing codebase

AI Skills
Launch
A

architecture-blueprint-generator

Analyzes codebases to generate comprehensive architectural documentation

AI Skills
Launch
C

create-architectural-decision-record

Structured Architectural Decision Record generator

AI Skills
Launch
O

oo-component-documentation

Create or update standardized object-oriented component documentation

AI Skills
Launch
P

project-workflow-analysis-blueprint-generator

Generates detailed implementation blueprints by analyzing project architecture

AI Skills
Launch
U

update-oo-component-documentation

Update existing object-oriented component documentation following industry best

AI Skills
Launch

create-oo-component-documentation FAQ

What can I point it at?

A single component file, or a folder whose source files are all analyzed.

What standards does it follow?

The C4 model levels, the Arc42 template and the IEEE 1016 design description standard.

Who is the audience?

Developers and maintainers of the component.

Should the design team check it?

Yes. Intent that is not visible in the code should be confirmed by the people who designed the component.

How do I install it?

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

What security audits does it have?

skills.sh lists three audits: Gen Agent Trust Hub Pass, Socket Pass and Snyk Pass.

What are the best create-oo-component-documentation alternatives?

Popular alternatives to create-oo-component-documentation include acquire-codebase-knowledge, architecture-blueprint-generator and create-architectural-decision-record. See all create-oo-component-documentation alternatives

Developer Stuff

Badges