The Autter platform can generate repository documentation from code and repository context. Use it to orient reviewers and contributors before they make or approve changes.
Documentation areas
Generated content may include:
- repository overview and setup
- system architecture
- important modules and files
- APIs and data models
- ownership signals
- technical debt and risk context
Use the wiki during review
The wiki is useful when you need to answer questions such as:
- Which service owns this behavior?
- What depends on this module?
- Where is the data model defined?
- Which repository pattern should this change follow?
- Who has recent context on this area?
Generated documentation can become stale after code changes. Verify important claims against the current repository before making a design or merge decision.
Keep documentation useful
- Generate the wiki after connecting the repository.
- Review key architecture and setup pages for obvious errors.
- Refresh it after significant structural changes.
- Link authoritative human-written documentation where it should take precedence.
- Report or correct generated content that could mislead contributors.
Do not treat generated documentation as the source of truth for security controls, data handling, or operational procedures. Link the approved internal source instead.
