Administrative Documentation
The SPaDE project is intended, en route to its more ambitious goals, to transform engineering design and construction, starting with software development.
It is now clear to me that an important part of that is project management and administration, which will need to continuously evolve as the capabilities of AI systems evolve, and their role becomes more substantial.
Because of the shifting balance between human and AI contributions, it is preferable to document roles in ways which are agnostic as to whether the role is filled by a human or an AI system.
Agents (including Grok Build) should take in this directory, via this README, rather than treating AGENTS.md as the project methods manual. AGENTS.md is only Grok-specific (and similar) advice. Document placement is in amms001.md.
Working practice (pro-tem)
Three uses of agents, not two products doing the same job:
- Grok Build is for interactive work and high-level discussion. It always uses a Grok LLM. Retained memory is in
~/.grok/memory/ (keyed on origin, shared by clones and worktrees of this repo), not in the git tree. Sessions are per working directory. Outcomes belong in docs/ (and code); memory is continuity only. Area branches and worktrees: ampd004.md.
- Copilot coding agent is for work scheduled through GitHub (issues,
@copilot, coding-agent PRs). Its model is often selectable and is not assumed to be Grok. It has no local workspace, so tests run in the SPaDE container. Procedure: ampd001.md, ampd002.md, ampd008.md.
- Copilot code review on a pull request that Grok authored is independent review of that patch (ampd005.md). It is not the same role as (2). A Copilot-authored PR is not independently reviewed by Copilot; the human reviews it (Grok may help).
Do not use Copilot Chat in the local tree as a substitute for (1) or for (3).
This documentation falls into the following categories:
Methods and standards
- amms001.md Project Structure and Documentation Policy (including: subsystem-specific architecture/design/implementation in the subsystem directory;
docs/ only for whole-system or cross-subsystem material)
- amms002.md Roles, Responsibilities, Tasks
- amms003.md Workflows
- amms004.md Collaborative Guidelines
- amms005.md Guidance for AI Contributions
- amms006.md Glossary Link Maintenance
- amms007.md Glossary Augmentation Procedure (historic, pro-tem)
- amms008.md LLM Wiki, in progress and not authoritative
Process or procedure descriptions
- ampd001.md GitHub-scheduled Copilot agent; tests in the SPaDE container
- ampd002.md Process for Copilot completing code and test assignments
- ampd003.md Conversational Documentation Development Procedure
- ampd004.md Branches, worktrees, and sessions
- ampd005.md Independent review: Grok authors, Copilot reviews; PRs into
main; later LLM-evaluation questions
- ampd007.md Glossary Augmentation Procedure
- ampd008.md Copilot Delegation Procedure with Task Documents
Plans and strategies
Testing and evaluation
Not yet a method. Questions about evaluating SPaDE as a tool for LLMs (MCP clients, frozen prompts, independence from the authoring agent) are listed at the end of ampd005.md.
Task Descriptions
- amtd001.md Task Description for Review of Hyperlinks in Project Documentation
- amtd002.md Task Description for Linking Project Documentation to the SPaDE Glossary
- amtd003.md Task Description for Augmentation of the SPaDE Glossary
- amtd004.md Task Description for Implementation of Glossary Automation Scripts
Chat Logs
- amcl001.md Chat Log: Conversational Documentation Development Procedure
- amcl002.md Grok web discussion links formerly listed under
drafts/
Code and Scripts
- amcd001.py - Script for adding glossary links to documentation
- Dynamically loads terms from glossary
- Supports incremental operation with
--since parameter
- Generates review reports
- Handles file filtering and dry-run mode
- amcd002.py - Script for extracting terms from glossary
- Parses glossary file to extract all terms and anchors
- Outputs in multiple formats (python, json, text)
- Handles term variations and compound terms
- Used by amcd001.py for dynamic term loading
- amcd003.py - Script for discovering potential glossary terms
- Scans documentation for technical terminology
- Filters by frequency and importance
- Outputs candidate terms with usage contexts
- Supports glossary augmentation workflow