document-work

Generate structured Markdown files documenting Git-based work patterns, decisions, and project state.

7|1|Updated Nov 3, 2025
One-click install
npx skills add https://github.com/ar4mirez/samuel --skill document-work-ar4mirez
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-work
Source: https://github.com/ar4mirez/samuel/tree/main/template/.claude/skills/document-work
Command: npx skills add https://github.com/ar4mirez/samuel --skill document-work-ar4mirez

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the process of documenting significant work, decisions, and emerging patterns, ensuring that valuable project knowledge is captured and retained for future reference and team collaboration.

Core Features & Use Cases

  • Pattern Capture: Identifies and documents recurring code structures, API contracts, and error handling approaches.
  • Decision Logging: Creates detailed records of architectural choices, tradeoffs, and the rationale behind them.
  • State Management: Tracks work in progress, blockers, and next steps for seamless session handoffs.
  • Use Case: After completing a complex feature, use this Skill to automatically generate documentation for new patterns, decisions made during development, and the current state of the work, making it easy for other team members to understand and contribute.

Quick Start

Use the document-work skill to document the work completed today on the new user authentication module.

Frequently Asked Questions about document-work

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

FAQPage Schema
How do I document project decisions and work patterns from Git history?

To document project decisions and work patterns, this Skill analyzes Git history to automatically generate structured markdown files. It extracts architectural choices, recurring code structures, and ongoing work status to facilitate team knowledge capture.

What is the best way to capture architectural decisions and rationale for software development?

Capturing architectural decisions is best achieved by logging them into predefined markdown templates. This method records specific architectural choices, tradeoffs, and the underlying development rationale, ensuring valuable project knowledge is retained for future reference.

Can I track work in progress and blockers for software session handoffs?

Yes, you can track work in progress and blockers for session handoffs. The system manages project state by documenting ongoing work status, current blockers, and next steps into structured markdown files, enabling seamless development session transitions.

Does this documentation workflow require Git for version analysis?

Yes, this documentation workflow requires Git for version analysis. It relies on Git history to identify significant work, recurring patterns, and project state changes before generating the structured markdown documentation outputs for the team.

How do I log recurring code structures and API contracts during development?

You log recurring code structures and API contracts by using pattern capture features. This identifies and documents recurring code structures, API contracts, and error handling approaches into predefined markdown templates for ongoing knowledge retention.