Repository navigation
application_agents_doc_agent
GitHub Action edited this page Oct 1, 2026
·
1 revision
iso_doc_type: "Specification" iso_viewpoint: "ComponentView" type: "module" title: "factory-application::agents::doc_agent β DocumentationAgent" source_path: "crates/factory-application/src/agents/doc_agent.rs" description: "ISO 42010 ComponentView / ISO 15289 Specification documentation for factory-application::agents::doc_agent β DocumentationAgent." tags: ['iso42010', 'okf', 'component_view', 'rust', 'ast'] timestamp: "2026-10-01T14:00:00Z" generated: "agent:okf-professional-documenter" verified: "true" last_verified_commit: "fbdc5848"
Source:
crates/factory-application/src/agents/doc_agent.rsLayer: Application
sequenceDiagram
participant DOC as DocumentationAgent
participant AST as AST Parser
participant Wiki as wiki/ Directory
participant OSR as OSR Calculator
DOC->>AST: Parse source files for public symbols
AST-->>DOC: Symbol list (structs, traits, functions)
DOC->>Wiki: Generate OKF markdown per module
DOC->>OSR: Calculate Omission/Staleness Ratio
OSR-->>DOC: OSR metric
alt OSR < 5%
DOC->>DOC: β
Quality gate passed
else OSR >= 5%
DOC->>DOC: β Regenerate missing docs
end
| Metric | Formula | Gate |
|---|---|---|
| Missing Symbols | undocumented_public_symbols / total_public_symbols |
< 5% |
| Stale Pages | pages_not_updated_since_last_code_change / total_pages |
< 5% |
| Combined OSR | max(missing, stale) |
< 5% |
Related: OSR Calculator Β· HITL Governance
- Business Context
- Strategic Design
- Tactical Design
- Agent Specifications
- Runtime Sequences
- Infrastructure Adapters
- Mission Data Model
- lib.md
- gitlab_verifier.md
- poller_service.md
- telemetry_export.md
- Agents
- Workflows
- Bridge
- Utils
- lib.md
- github.md
- gitlab.md
- jira.md
- kafka.md
- ziti.md
- vault.md
- r2r.md
- semantica.md
- aethalgard.md
- mcp_client.md
- pipeline_classifier.md
- s3.md
- sentry.md
- security_validator.md
- cursor_store.md
- git_poller.md
- lib.md
- main.md
- protocol.md
- sandbox.md
- scratch.md
- feedback_route.md
- github_webhook.md
- Skills
-
Tools
- mod.md
- bridge.md
- deep_research_tool.md
- execute_code.md
- get_factory_status.md
- index_code.md
- inspect_kafka_topic.md
- launch_sandbox_pod.md
- list_minio_buckets.md
- list_minio_objects.md
- plan_mission.md
- retrieve_context.md
- run_tests.md
- search_jira.md
- security_review.md
- spec_kit_tasks_to_issues.md
- spec_kit_tool.md
- update_mission_status.md