Skip to content
Octo × Documentation PT Request an assessment

Octo for documentation · scribe arm

What the team learns gets written down.

According to DORA, documentation quality drives every technical practice it has studied, and documentation has to be actively created and maintained. Octo's scribe arm works at this step: it maintains the system dossier (platform map, access, database, domain, deploy and findings), the project's status and decisions, keeping rules, knowledge and status separate. Whatever becomes a project rule is approved by the tech lead.

Delivered tasks, decisions and findings go into Octo, which returns the system dossier and the dated record of decisions. INPUT DELIVERED TASKS DECISIONS FINDINGS DOSSIER OF THE SYSTEM DECISIONS DATED delivery → record → approved rule OCTO × SOFTWARE DOCUMENTATION ES-09
ArmScribeworks at this step
Conventional Commits1.0.0type, scope and description
Sources6listed at the end of the page
01

What Octo does in documentation.

Four possible deliverables. What becomes a project rule and the team's conventions are decided by the tech lead.

System dossier

The scribe maintains the platform map, access, database, domain, deploy and findings, updated with every task.

Deliverable: up-to-date dossier

Status and decisions

Records the project's status and dated decisions, separating what is a rule, what is knowledge and what is just the day's status.

Deliverable: dated decisions on record

Rules that always apply

Whatever must always happen becomes a hook, a deny rule or managed settings; the project's instructions file is for guidance.

Deliverable: proposed rule for approval

Commits that state why

Small commits, with a short summary line and the reason for the change, in the convention the team chooses, such as Conventional Commits.

Deliverable: a readable Git history
02

Eight arms, one dossier.

The same Octo cycle, applied to this step. Each arm has a narrow role; your company's tech lead is in charge and approves.

  1. Discovery

    Delivers the map

    What discovery surveyed becomes the platform map in the dossier.

  2. Data

    Delivers the model

    The database study becomes the dossier's database page.

  3. Security

    Delivers the findings

    Security findings and accepted risks are recorded.

  4. Architecture

    Delivers the decisions

    Each architecture decision goes in with its date and reason.

  5. Development

    Writes clear commits

    A message with the summary, the reason and the task reference.

  6. Review

    Checks the documentation

    The delivery's documentation also goes through review.

  7. Release

    Records the deploy

    How to release and how to verify it lives in the dossier.

  8. Documentation

    Maintains the dossier

    Keeps rules, knowledge and status separate, and updates the status at the end of the day.

Octo writes and maintains; approving what becomes a project rule, defining the team's commit convention and validating documentation delivered to third parties belong to the tech lead.

03

Who does what in documentation.

What the scribe maintains and what remains your team's decision.

DocumentOcto armStays with the tech lead
System dossierScribeRead and correct
Project decisionsScribeApprove what becomes a rule
Commit messagesDevSet the team's convention
API documentationDev, from the OpenAPI descriptionValidate what goes to third parties
04

From request to routine.

Three steps. Each one only makes sense once the previous one has shown results on your team.

A proposal, not a promise

1 Today

Initial dossier

The scribe builds the dossier from what discovery surveyed.

  • Platform map
  • Database and deploy
  • Findings
Benefit: the system is described in one place
2 Next

Dated decisions

Every project decision is now recorded with its date and reason.

  • Decisions on record
  • End-of-day status
Benefit: no one reopens what has already been decided
3 Later

Rules that always apply

Whatever must always happen moves out of the text and becomes a tool rule.

  • Hooks and deny rules
  • Periodic dossier review
Benefit: the rule doesn't depend on someone remembering
05

Confirmed by source.

Each point below has a source published by the organization responsible for the standard, the specification or the tool, or in Brazilian federal law. The sources are in the next section.

7

points with a published source, each with its reference alongside.

ConfirmedDocumentation quality
DORA finds that documentation quality drives the adoption of each of the technical practices it studied.Source: DORA, documentation quality
ConfirmedOngoing work
Documentation has to be actively created and maintained, and that takes work.Source: DORA, documentation quality
ConfirmedInstructions file
CLAUDE.md is a markdown file at the project root that Claude Code reads at the start of every session.Source: Claude Code, overview
ConfirmedGuidance and rules
Whatever must happen every time should become a hook, a deny rule or managed settings.Source: Claude Code, best practices
ConfirmedConventional Commits
Conventional Commits 1.0.0 is a specification for adding human- and machine-readable meaning to commit messages, in the format type, optional scope and description; fix maps to PATCH, feat to MINOR and BREAKING CHANGE to MAJOR in SemVer.Source: Conventional Commits 1.0.0
ConfirmedCommit message
The Git documentation suggests, without requiring it, starting the message with a short line of up to 50 characters, a blank line and then the description.Source: Git, git-commit
ConfirmedOpenAPI and documentation
The OpenAPI description can be used by documentation generation tools to display the API.Source: OpenAPI Initiative, OAS 3.2.1
06

What Octo does and what stays with you.

Octo prepares everything, but does not sign. The document of record stays with whoever is accountable for it.

Octo prepares

Maps, plans, codes on the task branch, reviews with evidence and prepares the release: plans, code, reviews, security reports and the system dossier.

Deliverable: material ready for review

Your team reviews

Whoever is in charge is the company's tech lead or senior developer: they approve the plan, review the PR and merge it. Nothing goes to production without their approval.

Step: approval by whoever is in charge

Who signs and is accountable

Octo does not sign and is not accountable for the system. The tech lead accepts the risk and is accountable for the system in production; a security report or opinion is signed by a professional at the company.

Accountable: the company's tech lead
07

Sources.

DORA, Claude Code documentation, Conventional Commits, Git documentation and the OpenAPI Initiative. Accessed October 31, 2026.

The system, documented and up to date.

The assessment starts with what your team has already documented, without changing anything. You get the proposed dossier and decide with it in hand.