dev-diary

Write and reconcile xmris dev-diary entries documenting implementation decisions.

5|1|Updated Feb 18, 2026
One-click install
npx skills add https://github.com/andrewendlinger/xmris --skill dev-diary
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dev-diary
Source: https://github.com/andrewendlinger/xmris/tree/main/.claude/skills/dev-diary
Command: npx skills add https://github.com/andrewendlinger/xmris --skill dev-diary

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you document important implementation decisions in xmris before and after they are built, so contributors can review the reasoning behind a change without reading the whole plan or diff.

Core Features & Use Cases

  • Decision records: Write a short, rendered dev-diary entry when a change involves real tradeoffs, new conceptual surface, or a multi-PR chain.
  • Two-pass workflow: Draft the entry at the start of the change as a review gate, then reconcile it at the end so it matches the merged code.
  • Documentation discipline: Keep the story concise, include assumptions while work is pending, and remove them once the implementation is real.
  • Use case: A contributor adds a new decorator contract or chooses between viable architectures and wants a reviewable explanation of why that path won.

Quick Start

Write a dev-diary entry for this xmris change, then ask me whether to publish it now or skip it.

Frequently Asked Questions about dev-diary

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

FAQPage Schema
How do I document implementation decisions for a multi-PR refactor?

To document implementation decisions for a multi-PR refactor, write a dev-diary entry explaining why the change was made and how it ended up. This provides a reviewable record of the reasoning without requiring contributors to read the entire diff.

What is a two-pass decision record workflow?

A two-pass decision record workflow drafts an entry at the start of a change as a review gate, then reconciles it at the end to match the merged code. This preserves the reasoning behind the change while removing pending assumptions once the implementation is real.

When should I write a decision record for a new conceptual surface?

Write a decision record when a change involves real decision weight, such as choosing between viable approaches, adding new conceptual surface, or coordinating multi-PR refactors. This ensures the tradeoffs and reasoning are preserved for future review.

How do I keep markdown documentation concise when explaining architectural tradeoffs?

Keep markdown documentation concise by writing a short dev-diary entry that captures the story without explaining the whole plan. Include assumptions while work is pending, and remove them once the implementation is complete and the final pass is reconciled.

Does this dev diary workflow require a rendered first-pass draft before implementation?

Yes, the dev diary workflow requires a rendered first-pass draft before implementation. This draft acts as a review gate to evaluate the reasoning, followed by a reconciled final pass that aligns with the merged code and removes pending assumptions.