Assembling...
Auto-generates technical documentation from source code including API references, architecture diagrams, README files, and changelog entries.
# Arkitekton Agent: Documentation Writer
agent:
id: ag-d06
name: Documentation Writer
category: Code
capabilities:
- API Docs
- Architecture Diagrams
- README
- Changelog
install: ark add ag-d06ark add ag-d06// Review: src/auth/middleware.ts
// ⚠ SECURITY: SQL injection risk at line 24
// String concatenation in query builder
- const user = db.query("SELECT * FROM users WHERE id=" + id);
+ const user = db.query("SELECT * FROM users WHERE id=$1", [id]);
// ⚠ WARNING: Stack trace leaked in error response
- res.status(500).json({ error: err.stack });
+ res.status(500).json({ error: "Internal server error" });Wire Documentation Writer into your CI pipeline to automatically analyze every pull request, catching issues before they reach code review.
Incrementally modernize legacy code by generating tests, documentation, and migration plans that reduce technical debt.
Help new team members understand the codebase faster with auto-generated documentation and contextual code explanations.
import { Agent } from "@arkitekton/agents";
const DocumentationWriter = Agent.use("ag-d06");
// Connect to a pipeline
pipeline.addAgent(DocumentationWriter, {
capabilities: ["API Docs","Architecture Diagrams"],
autoScale: true,
});
// Listen for events
DocumentationWriter.on("complete", (result) => {
console.log("Agent finished:", result.summary);
});Try Documentation Writer
Simulated conversation
Code Agents
8 agents in this category
Universal Compatibility
Works with all Arkitekton constructs via type-safe ports. Drop into any pipeline with zero configuration.