update-docs

Generate and update living project documentation from feature work and architecture decisions.

11|2|Updated Apr 7, 2022
One-click install
npx skills add https://github.com/nullhack/temple8 --skill update-docs-nullhack
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/nullhack/temple8/tree/main/.opencode/skills/update-docs
Command: npx skills add https://github.com/nullhack/temple8 --skill update-docs-nullhack

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates generation and updating of living project documentation, ensuring decision records, architecture notes, and feature outcomes stay aligned with the codebase.

Core Features & Use Cases

  • Refreshes docs/system.md Context and Container sections after feature acceptance.
  • Updates the living glossary and dynamic sections in docs/index.html based on ADRs, discovery, and completed features.
  • Supports stakeholder requests to surface a current system overview without manual edits.

Quick Start

Run the update-docs workflow after a feature is accepted to refresh all living documentation.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I keep project documentation in sync with code changes automatically?

You can keep project documentation in sync with code by running an automated workflow that reads completed features and ADRs to refresh living docs like system.md, index.html, and glossary.md without manual edits.

How does living documentation update after a feature is accepted?

Living documentation updates by reading inputs from discovery.md, system.md, completed feature folders, and ADR files, then writing refreshed Context, Container, and glossary sections back into system.md and index.html.

What's the best way to maintain architecture decision records alongside feature documentation?

The best way to maintain architecture decision records alongside feature docs is to automate the extraction of ADR inputs into a living glossary and dynamic index.html sections, ensuring architecture notes stay aligned without altering source ADR files.

Can I generate a system overview for stakeholders from existing ADR and discovery files?

Yes, you can generate a current system overview for stakeholders from existing ADR and discovery files by running a documentation workflow that reads those sources and outputs updated system.md and index.html summaries.

Do I need to manually edit docs/system.md and docs/index.html when features change?

No, you do not need to manually edit docs/system.md or docs/index.html when features change. An automated documentation process reads completed feature files and ADRs to write updates to those files directly.

Will updating living documentation modify my original ADR source files?

Updating living documentation will not modify your original ADR source files. The process strictly reads from ADR and discovery inputs to write updates into system.md, index.html, and glossary.md, leaving source files untouched.