nilecui/skillsbase
Overview
This skill generates clear, maintainable technical documentation for codebases and services. It produces API docs, component libraries, README files, architecture diagrams, changelogs, and developer guides using tools like OpenAPI/Swagger, JSDoc/TypeDoc, Storybook, VitePress, and Docusaurus. The output is versioned, testable, and designed to be a single source of truth for developers and stakeholders. It focuses on practical examples, automated checks, and audience-specific content.
How this skill works
I extract structured metadata from code (comments, schemas, and types) and generate human-friendly documentation pages and spec files. I can scaffold README templates, produce OpenAPI/Swagger specs for REST, generate GraphQL schema docs, create Storybook component stories, and assemble static sites with Docusaurus or VitePress. I add CI checks for broken links and runnable code examples to keep docs fresh and reliable. Diagrams and ADRs are created or formatted to document architecture and decisions.
When to use it
- Documenting REST or GraphQL APIs for internal or public consumption
- Creating or maintaining a component library with Storybook
- Writing or updating README, onboarding, or configuration guides
- Generating API reference sites using OpenAPI, TypeDoc, or JSDoc
- Creating architecture diagrams, ADRs, changelogs, and migration guides
Best practices
- Treat docs as code: keep docs in version control and review changes via PRs
- Prefer generated single-source-of-truth from code and schema comments
- Include runnable examples and test them in CI to prevent rot
- Tailor content by audience: public API docs, developer guides, and ops runbooks
- Automate link checks, example execution, and versioned site builds
Example use cases
- Auto-generate OpenAPI docs from annotated routes and serve Swagger UI at /api-docs
- Build a Docusaurus site with guides, API reference, and a searchable sidebar
- Create Storybook stories and component docs for a design system
- Write a README + CHANGELOG with semantic versioning and migration notes
- Extract and test code examples from documentation during CI to ensure accuracy
FAQ
Yes. By generating docs from code comments and schemas and running CI checks for links and example tests, it minimizes manual drift.
Which tools does it support for site generation?
Common static site generators like Docusaurus, VitePress, and tools like Storybook, TypeDoc, Swagger/OpenAPI, and JSDoc are supported.
19 skills
This skill generates clear, maintainable technical documentation for APIs, components, READMEs, and guides using established docs tooling.
This skill helps you master authentication and authorization patterns for secure, scalable APIs, including token flows, RBAC, OAuth2, and session management.
This skill automates senior frontend workflows with component generation, bundle analysis, and scaffolding to accelerate React/Next.js projects.
This skill guides you in creating well-structured Claude Code Agent Skills, ensuring SKILL.md frontmatter, validation, and progressive disclosure for reliable
This skill applies Acme brand guidelines to documents, ensuring consistent colors, typography, layout, and messaging across presentations, spreadsheets, PDFs.
This skill helps design scalable data pipelines and governance with Python, SQL, Spark, and Airflow for robust, production-grade analytics.
This skill helps you design and implement asyncio patterns for high-performance asynchronous Python applications, enabling scalable I/O-bound and concurrent
This skill helps you create, validate, and render Mermaid diagrams from natural language descriptions or code analysis.
This skill helps you write clearly and concisely by applying Strunk's rules to documentation, messages, and UI text.
This skill guides PostgreSQL table design by enforcing 3NF normalization, appropriate data types, indexing strategies, and safe schema evolution.
This skill optimizes AI documentation and llms.txt generation to improve clarity, structure, and retrieval for Claude, Copilot, and other tools.
This skill consolidates multiple deepresearch results into a single comprehensive report through iterative processing with user supervision.
This skill helps you transform rough ideas into fully formed designs by guiding structured Socratic questioning and presenting incremental options.
This skill implements hybrid search by combining vector and keyword results to boost recall in RAG systems and search engines.
This skill helps you design and optimize production prompts using advanced patterns like few-shot, chain-of-thought, and templates to improve reliability.
This skill helps you build knowledge-grounded AI by integrating vector stores, embeddings, and retrieval strategies for accurate, sourced answers.
This skill helps you rapidly build accessible React UIs with shadcn/ui by copying production-ready blocks and integrating Tailwind patterns.
This skill writes clear, runnable documentation in docs/ using the Eight Rules and Diataxis to ensure discoverable, linked, and up-to-date content.
This skill designs multi-stage CI/CD pipelines with approval gates, security checks, and deployment orchestration to accelerate safe software delivery.