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 intended to document roles in ways which are agnostic as to whether the role is filled by a human or an AI system.

This documentation falls into the following categories:

• Methods, processes and standards
• Process or procedure descriptions
• Plans and strategies
• Testing and evaluation
• Task descriptions
• Chat logs
• Code and scripts

Methods, Processes and Standards

• amms001.md Project Structure and Documentation Policy
• 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

Process or procedure descriptions

• ampd001.md Using GitHub Copilot Agent with SPaDE - Process for assigning code-and-test tasks to Copilot agents
• ampd002.md Using GitHub Copilot Agent with SPaDE - Process for Copilot in completing code and test assignments.
• ampd003.md Conversational Documentation Development Procedure

Plans and strategies

• ampl001.md SPaDE Project Action Plan
• ampl002.md Prototyping Strategy
• ampl003.md Project Management

Testing and evaluation

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

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