writeup

Creates situational writeups for project contexts in docs/writeups folders using frontmatter templates.

Updated Feb 8, 2026
One-click install
npx skills add https://github.com/idealic-ai/engine --skill writeup-idealic-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writeup
Source: https://github.com/idealic-ai/engine/tree/main/skills/writeup
Command: npx skills add https://github.com/idealic-ai/engine --skill writeup-idealic-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Lightweight, semi-permanent situational documents help teams capture and share project context without bloated processes or heavy tooling.

Core Features & Use Cases

  • Lightweight, no-session writeups stored in apps//docs/writeups/ or packages//docs/writeups/
  • Documents current situations, context, and suggested improvements to aid onboarding and decision making.
  • Works with a simple frontmatter-driven template to standardize documentation.

Quick Start

Create a new writeup for a topic by placing it under apps//docs/writeups/ or packages//docs/writeups/ and following the template.

Frequently Asked Questions about writeup

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

FAQPage Schema
How do I create lightweight situational documentation for a project context?

To create situational documentation, use a frontmatter-driven template to capture current project contexts and suggested improvements. Store these lightweight writeups directly under the apps/*/docs/writeups/ or packages/*/docs/writeups/ paths.

What is a situational writeup and when should I use it?

A situational writeup is a lightweight, semi-permanent document used to capture current project situations and context. Use it to aid team onboarding and decision making without requiring bloated processes or heavy tooling.

How do I structure project context docs without keeping session logs?

You can structure project context docs without session logs by using a simple frontmatter-driven template. This approach standardizes documentation while capturing current situations and suggested improvements directly in your docs/writeups directory.

Does the writeup documentation process require any dependencies or heavy tooling?

No, the writeup documentation process requires no external dependencies, sessions, or heavy tooling. It relies entirely on a simple frontmatter-driven template to standardize project context capture within your existing directory structure.

Where should I store situational project documentation in a monorepo?

Store situational project documentation in the apps/*/docs/writeups/ or packages/*/docs/writeups/ directories. This placement ensures that current situations, context, and suggested improvements are kept close to the relevant project code.