skills.rest
ulises-jeremias
ulises-jeremiasCOMMUNITY
Explore all skills by this author →
𝕏@ulisesjcfGitHub

dots-workstation-docs-generator

Generate and update project documentation from repository structure and git history.

2|3|Updated Apr 7, 2026
Search Tags:#project documentation#README#API reference#CHANGELOG#docs generation
One-click install
npx skills add https://github.com/ulises-jeremias/agentic-workstation --skill dots-workstation-docs-generator
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: dots-workstation-docs-generator
Source: https://github.com/ulises-jeremias/agentic-workstation/tree/main/home/dot_local/share/agentic-workstation/skills/dots-workstation-docs-generator
Command: npx skills add https://github.com/ulises-jeremias/agentic-workstation --skill dots-workstation-docs-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the generation and updating of documentation for projects, including README, CHANGELOG, API references, and AGENTS.md files, saving time and ensuring accuracy.

Core Features & Use Cases

  • README Generation: Automatically creates or updates README files based on repository structure and configuration files.
  • CHANGELOG Creation: Generates CHANGELOG entries based on git history, providing a comprehensive record of changes.
  • API Reference Documentation: Converts OpenAPI and GraphQL schemas into human-readable API documentation.
  • AGENTS.md Creation: Generates a starter file for onboarding AI assistants into new projects.
  • Use Case: For a project with a complex architecture, this Skill can help maintain up-to-date documentation without manual effort.

Quick Start

Run the dots-workstation-docs-generator skill to generate and update your project's documentation.

Frequently Asked Questions about dots-workstation-docs-generator

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

FAQPage Schema
How do I automate project documentation generation from git history?▼

Automated project documentation generation analyzes your repository structure, git history, and configuration files to produce README and CHANGELOG files. It records changes by parsing git commits to create comprehensive CHANGELOG entries without manual input.

Can I generate API reference docs from OpenAPI and GraphQL schemas?▼

API reference generation converts OpenAPI and GraphQL schemas into human-readable documentation. It processes schema definitions directly to create structured API references, ensuring your documentation stays synchronized with your API contracts.

What is the best way to keep a README updated for a complex software architecture?▼

Keeping a README updated for complex architectures is best handled by analyzing the repository structure and configuration files automatically. This method generates and updates README content based on actual codebase changes, eliminating manual synchronization effort.

How do I create an AGENTS.md file to onboard AI assistants into a new project?▼

Creating an AGENTS.md file for AI assistant onboarding involves generating a starter file from your repository structure. This provides a standardized entry point that helps AI agents understand the project context and configuration quickly.

Do I need any dependencies to generate and update project documentation?▼

No dependencies are required to generate and update project documentation. The process operates directly on your repository structure, git history, and configuration files to produce README, CHANGELOG, API references, and AGENTS.md files.

Related Skills

Explore More Software Engineering Skills→
tsuna44tsuna44

xddp.fill-rulebook

Generate project-rulebook documentation from repository structure and git history.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
geinalageinala

docs-writer

Write, edit, and review Markdown documentation against project standards.

Official
Advanced
davidyohdavidyoh
2

obsidian-cloudflare-pages

Publish Obsidian markdown notes to Cloudflare Pages using Quartz.

Community
Intermediate