Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 3.71 KB

File metadata and controls

74 lines (53 loc) · 3.71 KB

LLM Workflow

A reusable Markdown workflow for building a personal or team knowledge layer with LLM agents.

This repository stores the portable workflow, templates, and maintenance rules only. It must not contain company documents, private meeting transcripts, proprietary code, customer data, project-specific decisions, or any other sensitive source material.

Core Idea

The workflow separates knowledge work into three layers:

Layer Purpose
Raw sources Original documents, meeting audio, transcripts, diffs, links, notes, and files. These remain immutable and instance-specific.
Knowledge layer LLM-maintained Markdown summaries, decisions, designs, logs, and indexes.
Rules and navigation Agent instructions, workflow rules, templates, indexes, and publication guards.

The reusable part lives in this repository. Each company, project, or private workspace should keep its own instance outside this public repo.

Repository Contents

Path Purpose
LLM_WORKFLOW.md Portable workflow protocol.
AGENTS.md Agent-facing rules for maintaining this repository.
docs/PUBLICATION_GUARD.md Rules that prevent reusable workflow files from being polluted by private context.
docs/SKILLS_INTEGRATION.md How this workflow should interact with a separate skills repository.
docs/INSTANCE_REGISTRY.md Where local instance links live and how agents resolve them.
docs/BOOTSTRAP_NEW_INSTANCE.md Checklist for starting a new private workflow instance.
docs/DOCUMENT_LAYERING_AND_READ_POLICY.md Page types, canonical status source, source/digest split, and default read policy.
docs/PAGE_LIFECYCLE_AND_ARCHIVE.md Lifecycle labels, completed work compression, superseded content, and archive rules.
docs/CONTEXT_BUDGET_AND_COMPRESSION.md Size budgets and compression moves for context-efficient pages.
docs/WORKFLOW_LINT_CHECKLIST.md Checklist for duplicate status, stale wording, source leakage into default context, and page bloat.
templates/ Public-safe templates for indexes, meetings, source notes, and workflow instances.

Recommended Instance Layout

Copy or adapt templates/instance-layout.md into a private workspace:

00_inbox/
01_requirements/
02_index/
03_design/
04_research/
05_development-log/
06_testing/
07_retrospective/
08_tools/
09_meetings/
10_communication/
99_archive/

The exact names can be localized. Keep the roles stable.

GitHub Safety Rule

Before committing to this public repository, verify that the change is reusable without private context. If a sentence only makes sense inside one company, one client project, or one private codebase, it belongs in that private instance, not here.

Related Repositories

For new projects, follow docs/BOOTSTRAP_NEW_INSTANCE.md.

Inspiration

This workflow is inspired by Andrej Karpathy's LLM Wiki pattern: