Audit your doc-ops
💡 Knowledge Artifacts
Are the trail of documents and images that result from the interactions taking place in your git repository. These range from issues and pull-request to discussions and code submissions. Most organizations have a wealth of Artifacts and may not even realize it.
Begin with an analysis of your repositories
Common Places to Find Artifacts
Pull-Requests
Have descriptions regarding architecture decisions & additional implementation details not documented anywhere else.
Markdown & RST
While having it in the repository is better than nothing, docs in repositories are not discoverable or searchable.
Tickets / Stories / Issues
Contains product specifications and implementation estimates that becomes lost/forgotten after project life cycle.
Wikis
Information can be scattered across multiple repos, multiple organizations.
Our analysis report delivers benchmark grades for your current Knowledge Artifacts
CURRENT
📚 Standard Docs
Needs Work (3/10)
Some docs in place varing in quality:
- - Multiple Issue Silos
- - Needs Taxonomy
- - Random Text Files
🏗 Architecture Docs
Needs Work (3/10)
A preliminary standard has been defined in one repo, adoption needed across the org.
🎓 Knowledge Docs
Decent (5/10)
Healthy artifacts container in: core-platform, sphinx, & ML-Data.
- - Needs Taxonomy
Organization Grade: (11/30) 33% F+
Our implementation guide will help you organize your artifacts, establishing your knowledge network
POST IMPLEMENTATION
📚 Standard Docs
Good (9/10)
Defined standard applied across all repos.
- - Healthy artifacts
- - Taxonomy In-Place
🏗 Architecture Docs
Good (8/10)
Some artifacts in place varying in quality:
- - Initial PRs Processed
- - Taxonomy In-Place
🎓 Knowledge Docs
Good (9/10)
Defined standard applied across all repos.
- - Healthy artifacts
- - Taxonomy In-Place
Organization Grade: (26/30) 86% B