Glean 拾遗
Recent picks

2picks · chronological

09-14

Healthy Documentation: A CTO's Case for Docs-First Engineering

A CTO's field notes on running a docs-first engineering culture: replace half-hour check-ins with a one-page memo, budget documentation time explicitly in estimates, and require a short "why X over Y" paragraph on every merged feature. He is candid about the failure modes — stale pages are worse than none, and some workarounds should be fixed in code rather than explained in three paragraphs of handbook. Concrete mechanisms include a lightweight CI check that fails the build when a new analytics event ships without a matching wiki entry, ADR and post-mortem templates, the Diátaxis split between tutorials and reference, and a part-time "docs gardener" who prunes dead links.

vadimkravcenko.com · 11 min · Developer Tools · Documentation · Engineering Culture
08-03

Automating cross-repo docs with GitHub Agentic Workflows

The 10-person Aspire team automated cross-repo documentation with GitHub Agentic Workflows. Workflows are authored as one Markdown file: the agent evaluates whether a merged PR needs docs, drafts content in a checked-out aspire.dev workspace, and emits JSON intent; a separate safe-outputs handler materializes writes with a GitHub App scoped to exactly two repositories. Over Aspire 13.3/13.4, 396 merged product PRs produced 82 docs PRs, all merged with a 44.8h median and SME review from the original feature's engineer. The key enabler: milestone titles resolve the target docs branch before the agent wakes. Draft-only PRs, protected files, and allow-listed base branches keep the action surface crisp. The post is honest about v1's 13% false-positive gate and prompt-budget limits on large diffs. Practical for teams shipping docs from a separate repo.

github.blog · 14 min · Agentic Workflows · Agents · AI Engineering