sdlc-technical-writing

Plan and implement docs-as-code workflows with Markdown style guides and ADRs.

Updated Jun 5, 2026
One-click install
npx skills add https://github.com/dinoudon/sdlc-skills --skill sdlc-technical-writing
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sdlc-technical-writing
Source: https://github.com/dinoudon/sdlc-skills/tree/main/full/sdlc-technical-writing
Command: npx skills add https://github.com/dinoudon/sdlc-skills --skill sdlc-technical-writing

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Software organizations struggle to keep documentation synchronized with code, causing knowledge gaps and onboarding delays.

Core Features & Use Cases

  • Documentation strategy planning, docs-as-code pipeline, ADRs, runbooks, changelogs, knowledge-base management, accessibility and style guides.
  • Use cases include creating API reference docs, architecture docs, and troubleshooting guides across product lifecycles.

Quick Start

Draft and implement a docs-as-code workflow for your software project starting with a Markdown-based style guide and ADRs.

Frequently Asked Questions about sdlc-technical-writing

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

FAQPage Schema
What is docs-as-code and how does it keep documentation synchronized with code?

Docs-as-code manages documentation using the same workflows as software development. It keeps Markdown-based architecture docs, runbooks, and changelogs synchronized with code through structured pipeline practices, preventing knowledge gaps.

How do I create architecture docs and runbooks across the product lifecycle?

You can create architecture docs and runbooks by applying a structured documentation strategy across the product lifecycle. This involves using Markdown-based style guides, ADRs, and diagrams to standardize technical writing outputs.

What's the best way to structure a technical writing style guide for software teams?

The best way to structure a technical writing style guide is to implement it as Markdown-based docs-as-code. This integrates accessibility standards, information architecture, and style guidelines directly into your software team's workflow.

Does this docs-as-code approach support API reference docs and changelogs?

Yes, the docs-as-code approach supports API reference docs and changelogs. It streamlines knowledge-base management and documentation strategy planning across product lifecycles, covering everything from troubleshooting guides to ADRs.

When do I need architecture decision records for my software documentation?

You need architecture decision records when standardizing technical writing and capturing critical design choices. ADRs integrate with your docs-as-code pipeline to maintain accessible, structured knowledge bases alongside your codebase.