speedbird
Joined 7 years ago
Joined 7 years ago
Ultimately any useful documentation needs active curation.
Getting devs to do this well is hard. Agents can be driven to do a fair job through suitable prompt frameworks and repetition eg as PR reviewers.
I’ve had reasonable success with a combination of space dimensions structured requirements and component based indexes and time dimensions of decision records and commits.
Also a strong design model to give common structure - hex arch with ports and adapters and pure business logic.
YMMV
These days I split between technical notes a write and store on the project git so others and the AI tools can read - eg architecture decision records, bug reports etc and then a separate personal linear time journal of what I’m doing / thinking/ task lists meeting notes etc, often with links to the project specific docs. Great for searching. What I miss from paper is ability to quickly sketch diagrams.
Had a tour of the place back in the day before 9/11 and all that made the world a lot less fun.