skills.rest
slashwhy
slashwhyOFFICIAL
Explore all skills by this author →
WebsiteGitHub

architectural-documentation

Generate templates for implementation plans, ADRs, API specifications, and migration guides.

5|1|Updated Jan 16, 2026
Search Tags:#planning#architecture#documentation#api#implementation#adr
One-click install
npx skills add https://github.com/slashwhy/super-todo --skill architectural-documentation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: architectural-documentation
Source: https://github.com/slashwhy/super-todo/tree/main/.github/skills/architectural-documentation
Command: npx skills add https://github.com/slashwhy/super-todo --skill architectural-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides templates and guidance for documenting architectural decisions, implementation plans, and API specifications, ensuring clarity and consistency in project documentation.

Core Features & Use Cases

  • Implementation Plans: Create detailed step-by-step plans for feature development.
  • ADR Templates: Document architectural decisions with context, decisions, and consequences.
  • API Documentation: Standardize the format for documenting REST API endpoints.
  • Migration Guides: Provide clear instructions for handling breaking changes between versions.
  • Use Case: When planning a new microservice, use this Skill to generate an implementation plan outlining the API, data models, and deployment steps.

Quick Start

Use the architectural-documentation skill to generate an implementation plan template for a new user authentication feature.

Frequently Asked Questions about architectural-documentation

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

FAQPage Schema
How do I write an Architecture Decision Record for a new microservice?▼

An Architecture Decision Record documents architectural decisions by outlining the context, the decision made, and the resulting consequences. This provides structured formats for technical decisions to ensure clarity and consistency in project documentation.

What is the best way to document REST API specifications for feature development?▼

The best way to document REST API specifications is to standardize the format for documenting endpoints. This ensures software engineering teams maintain clear, consistent, and actionable API documentation during feature development.

How do I create an implementation plan template for a user authentication feature?▼

Creating an implementation plan template involves detailing step-by-step plans for feature development. This includes generating structured formats outlining the API, data models, and deployment steps for new features like user authentication.

When do I need a migration guide for breaking changes between versions?▼

You need a migration guide when handling breaking changes between software versions. This provides clear instructions and structured formats for technical decisions, facilitating knowledge sharing and onboarding by ensuring actionable project documentation.

Does architectural documentation work for onboarding new software engineering team members?▼

Architectural documentation supports software engineering teams in onboarding by providing structured formats for technical decisions and feature development. It facilitates knowledge sharing through clear implementation plans, API specifications, and Architecture Decision Records.

Related Skills

Explore More Software Engineering Skills→
packetalienpacketalien

create-architecture

Synthesize GDDs, ADRs, and engine references into a master architecture document.

Community
Advanced
codysumpter-cloudcodysumpter-cloud
2

writing-plans

Generate detailed implementation plans for software development tasks.

Community
Intermediate
sunholo-datasunholo-data
33

AILANG Release Manager

Automates end-to-end AILANG release management including pre-release checks, version bumps, changelog updates, git tagging, CI/CD verification, and release broadcasting.

Official
Intermediate
agnaldo4jagnaldo4j
1

wiki-maintenance

Map code changes to GitHub wiki pages and enforce update workflows.

Community
Advanced