Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Select an option

  • Save digispect-intel/9c66cafa659765ea721209b930ec1c52 to your computer and use it in GitHub Desktop.

Select an option

Save digispect-intel/9c66cafa659765ea721209b930ec1c52 to your computer and use it in GitHub Desktop.
Generalized project controller note template based on Outreach/controller

Controller — [Project Name]

Stable coordination hub for [organization/project purpose]. Keep this controller light: use it for navigation and scratch execution, while durable project memory lives in CRAFTs.

Source-of-Truth Notebooks

  • 00_models — Pydantic models & schema definitions
  • 01_source — primary data source or client integrations
  • 02_normalize — normalization and transformation logic
  • 03_pipeline — persistence, enrichment, filtering, update logic, status helpers
  • 04_batch — resumable batch processing and background runners
  • 05_export — export and packaging workflows
  • 06_inspect — read-only inspection and data-quality QA views

Operational Links

Durable Project Memory

Load these CRAFTs instead of duplicating changing state in this controller.

Direction: vision · decisions

Current work: status · todos · backlog · changelog

Reference: working_style · security · testing · runbook · url_mapping · data_model

Controller Hygiene

  • Put current state in status.
  • Put immediate next actions in todos.
  • Put durable future work in backlog.
  • Put dated completed changes in changelog.
  • Keep this controller note stable; add temporary investigation cells below and promote useful results into the right CRAFT before context refresh.

Working Checkpoints

When the controller gets to be a bit long, we'll try to make a working checkpoint. This is usually between 100k and 200k tokens, but should be at a natural stopping point or completion of some task so that we can have a smooth handover.

When I say, let's do a checkpoint, I mean let's complete the following tasks:

  1. summarize everything we've learned so far up until that point that can be captured into useful learnings, reusable code, or future work items
  2. refactor useful information into useful places. we'll want to extract any useful code, documentation, or accomplishments from this dialog and use it to update this project's code or CRAFT files, or possibly into project parent folder's CRAFT files.
  3. update this controller note if necessary.
  4. check git status and make logical commits or other operations when appropriate.
  5. recommend a new path to store this dialog in the archive, commit and push any changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment