The core method behind my variation of DDD is as follows. If you take anything away from this article, it's the following:
Feature release cycle
- Write/update high-level feature documentation based on bug ticket, context from technical conversations, and project information.
- Develop feature according to spec.
- Update documentation with relevant low-level technical information, if needed, during development.
- Generate documentation from the commented public interface (source code) of project using a Documentation Compiler. e.g.
DocC in iOS/Apple ecosystem,
pandoc in Python etc.
- Store documentation in Version Control for revision tracking.
This is a very powerful workflow, and helps not only developers, but even project managers to understand the project. It supports my principle of being open, because bad decisions are much harder to make if everybody can see/review them and easier to fix.
DDD only works effectively if it's implemented project-wide. My current guidelines to do this comprehensively are documented below. I personally think great documentation is worth the extra investment so I plan to advocate for it in my future work.
Guidelines for project-wide DDD:
- Capture high-level details into documentation immediately on team consensus. e.g. post-meeting, sprint review.
- Organise documentation into clear site paths. Ensure understandable URL paths.
- Complete lower-level documentation and link to high-level docs.
- Consider what would be helpful for new-joiners to know, don't ramble and focus on what matters.
- Add last modified date, and author to each page.
- Manage access control: Restrict external access to internal documentation, and limit internal access to relevant teams.
- Check documentation into Version Control for every change.
- Implement DDD Feature Release Cycle for each Jira ticket.
- Spell-Check / Lint documentation for every commit via CI tooling.
- Project Overview
- Project Guidelines
- Architecture Overview
- Testing Practices
- API Overview inc. Design Decisions
- Workflow Overview
- Tooling Overview
- Security Overview
- Project Style Guide
- Subsystem Overview
- Analytics Providers
- Other Third-Party Dependencies
- Features Overview
- Getting Started Documentation
- API Versions, OS Versions, Devices supported
- Code Review Guidelines
- PR Template
- API Implementation
- How to Use Version Control
- App Guidelines e.g. Slack Usage, Conferencing w/ Teams or Zoom etc., StackOverflow Teams, Emails, Postman, Dash, Figma, SQL DB Viewer
- Jira Usage Guidelines
- Testing Frameworks and Patterns
- Analytics Login details
- App Distribution Processes (internal + external) inc. logins
- Major Migration Details from old DB, OS or tooling versions
- Microservices Architecture
- API Types e.g. OAuth
- Public API Interfaces w/ function signatures, example request/response formats
- Test API Tokens
- Test Login Details
- Test Payment Details
After project-wide initial documentation has been completed, stabilised and approved, we can now update the documentation for every feature, and incrementally ensure all documentation is at parity with the app.
This methodology is subject to change, and I may update this in the future with further improvements based on my experience. Feel free to let me know if I am missing anything, or if you have feedback to improve further. I haven't actually implemented the below in a live project yet, but will update this post when I do (soon!). Thanks.