Files
Christopher Clendening 038442d4fd Add ML and QA Engineer documentation and workflows
- Introduced ML Engineer role with detailed responsibilities, success metrics, and workflow documentation.
- Established QA Engineer role with clear responsibilities, limitations, and success metrics.
- Created structured onboarding files for both roles, including README, ROLE, RESPONSIBILITIES, WORKFLOW, and SUCCESS_METRICS.
- Defined limitations for both roles to clarify boundaries and escalation paths.
- Enhanced security engineer documentation with responsibilities, limitations, and workflow for handling security reviews and findings.
2026-07-30 14:02:50 -04:00

86 lines
4.8 KiB
Markdown

# Local LLC — AI Company OS
This repository is the operating system for Local LLC: a software organization staffed by AI
agents, directed by a human Founder, and coordinated through ordinary engineering tools —
Gitea for source control, Plane for project management, and ACT Runner for CI.
It is not a product codebase. It is the constitution the company runs on: who the roles are,
how work is proposed and approved, how a task moves from idea to merged code, and what every
agent is expected to do when it doesn't know what to do.
## Start here
If you are an AI agent being onboarded into this company, **do not start writing code.**
Follow [ONBOARDING.md](ONBOARDING.md) in order. It will tell you what to read, in what
sequence, and when you're actually ready to pick up work.
If you are the Founder, [FOUNDER.md](FOUNDER.md) describes your role, authority, and the
planning workflow you run with the Executive Office before anything reaches the company.
## Repository map
```
Local-LLC/
├── README.md you are here
├── COMPANY.md mission, values, philosophy
├── FOUNDER.md the human's role and the approval gate
├── ORGANIZATION.md every role, reporting lines, org chart
├── WORKFLOW.md the sprint lifecycle end to end
├── ONBOARDING.md step-by-step read order for new agents
├── EMPLOYEE_HANDBOOK.md culture and conduct rules for AI employees
├── PLANE.md how Plane is used (epics, stories, tasks, sprints)
├── GITEA.md branch/commit/PR/review policy
├── ACT_RUNNER.md CI policy: triggers, retries, failures
├── CODING_STANDARDS.md formatting, testing, naming, architecture
├── SECURITY.md secrets, auth, dependencies, supply chain
├── DECISIONS.md how architecture decisions get recorded
├── MEMORY.md the organizational memory system
│
├── decisions/ the actual ADR log (numbered, append-only)
├── templates/ ADR, project, sprint, meeting, retro, bug, RFC, roadmap
├── memory/ company-wide memory: architecture, lessons, terminology
├── projects/ one folder per real project, following templates/PROJECT.md
└── employees/
├── project-manager/ full reference role — read this before building the rest
├── architect/ technical direction, ADRs, disagreement resolution
├── backend/ server-side / API / data-layer implementation
├── frontend/ user-facing interface implementation
├── ml/ model training, evaluation, ML infrastructure
├── qa/ independent verification; standing reject authority
├── security/ security review; standing merge-hold authority
├── devops/ CI/CD (ACT Runner), deployment pipelines
└── documentation/ keeps this repo and project docs accurate over time
```
Every `employees/<role>/` folder follows the same eight-file pattern established by
`project-manager/` (`README.md`, `ROLE.md`, `RESPONSIBILITIES.md`, `LIMITATIONS.md`,
`WORKFLOW.md`, `PROMPT.md`, `MEMORY.md`, `SUCCESS_METRICS.md`) — `project-manager/` was built
first because every other role's work arrives through Plane, which the Project Manager owns
operationally.
## What's real right now
- **Gitea** and **ACT Runner** (Linux and macOS runners) are deployed and reachable.
- **Plane** is not deployed yet — it is planned for the Portainer-managed monolith. `PLANE.md`
is written as policy that takes effect the day it comes online; nothing here depends on it
existing yet.
- Everything in this repo is agent-agnostic on purpose. No document names a specific model or
vendor. Roles are described by function (`Backend Engineering Agent`, `QA Agent`) so any
capable model can fill them.
## Versioning
This repo is versioned like software, not written once and frozen:
| Version | Milestone |
|---|---|
| v0.1 | Organization defined: all 14 root policy docs, 8 templates, the decision log, company memory seed files, and the Project Manager role built as the reference pattern |
| **v0.2 — current** | All nine employee roles fully built out (Project Manager, Architect, Backend, Frontend, ML, QA, Security, DevOps, Documentation) |
| v0.3 | Plane deployed and wired to the workflow described in PLANE.md |
| v0.4 | Gitea/ACT Runner placeholders replaced with real instance details |
| v0.5 | First real project run end-to-end through the full sprint lifecycle |
| v1.0 | Operational — the company runs itself within the Founder's approval gate |
Treat every merge to this repo the way you'd treat a merge to any other production system:
reviewed, consistent with what already exists, and never a placeholder pretending to be done.