skills.rest
havingautism
havingautismCOMMUNITY
Explore all skills by this author →
GitHub

project-requirements-md

Generate a Markdown requirements report documenting dependencies, architecture, and compliance.

190|18|Updated Mar 27, 2026
Search Tags:#documentation#markdown#codebase#requirements#report#codewiki
One-click install
npx skills add https://github.com/havingautism/Codemini-CLI --skill project-requirements-md
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: project-requirements-md
Source: https://github.com/havingautism/Codemini-CLI/tree/main/skills/project-requirements-md
Command: npx skills add https://github.com/havingautism/Codemini-CLI --skill project-requirements-md

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Transform a codebase into a concise Markdown CodeWiki requirements report, enabling instant understanding of a project's scope without wading through code.

Core Features & Use Cases

  • Codebase-to-report: Generates a structured CodeWiki-style Markdown document that captures dependencies, architecture, and compliance signals.
  • Onboarding & Handoffs: Produces a shareable reference for new team members and external stakeholders.
  • Output parity: Mirrors the HTML CodeWiki report format but outputs Markdown for plain-text review and diffs.
  • Output location: Writes the primary report to docs/requirements/{{date}}-project-requirements.md.

Quick Start

Run the project-requirements-md skill on your repository to generate docs/requirements/{{date}}-project-requirements.md.

Frequently Asked Questions about project-requirements-md

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

FAQPage Schema
How do I generate markdown documentation from a codebase for onboarding?▼

You can generate a codebase requirements report by running the skill on your repository to produce a single markdown document. This document captures dependencies, architecture, and compliance signals for onboarding and handoffs.

What is a CodeWiki markdown report and what does it include?▼

A CodeWiki markdown report is a concise plain-text document detailing a software project's dependencies, architecture, and compliance signals. It mirrors HTML CodeWiki structures to provide an instant overview of project scope without reading code.

Can I create a markdown requirements report for any programming language?▼

Yes, you can generate a markdown requirements report for software projects of any programming language. The skill analyzes the codebase structure and outputs a markdown document detailing dependencies and architecture regardless of the tech stack.

Does this codebase documentation tool output HTML or markdown files?▼

This codebase documentation tool outputs a single markdown file rather than HTML. It writes the report to docs/requirements/{{date}}-project-requirements.md, mirroring the HTML CodeWiki format to enable plain-text review and version control diffs.

What is the best way to document project architecture and dependencies for audits?▼

The best way to document project architecture and dependencies for audits is to generate a CodeWiki markdown report. It captures compliance signals and structural details in a plain-text format, producing a shareable reference for external stakeholder review.

Related Skills

Explore More Software Engineering Skills→
Monjyu1101Monjyu1101
1

gitnexus-explorer

Index a codebase into a knowledge graph with GitNexus and expose an interactive web UI.

Community
Advanced
testdoubletestdouble
198

html-summary

Convert stakeholder Markdown summaries into self-contained HTML executive reports.

Official
Advanced
ayeshakhalid192007-devayeshakhalid192007-dev
1

code-analyzer

Analyze codebases for security, performance, and maintainability issues across files and dependencies.

Community
Advanced
havingautismhavingautism
190

project-requirements

Generate interactive HTML CodeWiki project requirements reports from a codebase.

Community
Advanced