221 lines
8.3 KiB
YAML
221 lines
8.3 KiB
YAML
apiVersion: devrunbook.io/v1alpha1
|
|
kind: Playbook
|
|
metadata:
|
|
id: repository-understanding.onboarding-documentation
|
|
slug: onboarding-documentation
|
|
version: 1.0.0
|
|
title: Generate Developer Onboarding Guide
|
|
summary: Create accurate setup, architecture and contribution guidance from repository evidence without inventing unavailable
|
|
commands.
|
|
category: repository-understanding
|
|
tags:
|
|
- documentation
|
|
- onboarding
|
|
- setup
|
|
lifecycle: reviewed
|
|
riskTier: low
|
|
authors:
|
|
- name: DevRunbook Core Team
|
|
license: MIT
|
|
package:
|
|
files:
|
|
- path: prompt.md
|
|
role: template
|
|
digest: true
|
|
exportByDefault: false
|
|
- path: README.md
|
|
role: documentation
|
|
digest: true
|
|
exportByDefault: false
|
|
- path: CHANGELOG.md
|
|
role: changelog
|
|
digest: true
|
|
exportByDefault: false
|
|
- path: examples/minimal.yaml
|
|
role: example
|
|
digest: true
|
|
exportByDefault: false
|
|
- path: evaluations/static-structure.yaml
|
|
role: evaluation
|
|
digest: true
|
|
exportByDefault: false
|
|
spec:
|
|
type: run-pack
|
|
intent:
|
|
problem: Development work around generate developer onboarding guide is often underspecified, inconsistently executed
|
|
or reported without enough evidence.
|
|
outcome: Create accurate setup, architecture and contribution guidance from repository evidence without inventing unavailable
|
|
commands.
|
|
whenToUse:
|
|
- Use this playbook when the repository needs a bounded generate developer onboarding guide task with explicit evidence
|
|
and completion criteria.
|
|
- Use it when Codex should follow a repeatable workflow rather than improvise from a one-line request.
|
|
whenNotToUse:
|
|
- Do not use it when the desired outcome or authority boundaries are still materially undecided.
|
|
- Do not use it to access unavailable production credentials, bypass safeguards or claim validation that cannot be performed.
|
|
modes:
|
|
- guided
|
|
defaultMode: guided
|
|
autonomy:
|
|
min: plan
|
|
max: verify
|
|
default: plan
|
|
inputs:
|
|
- key: targetPlatform
|
|
label: Target platform
|
|
description: Select the primary platform on which the result must work or be verified.
|
|
type: enum
|
|
required: true
|
|
sensitive: false
|
|
includeInOutput: true
|
|
default: container
|
|
options:
|
|
- linux
|
|
- windows
|
|
- macos
|
|
- container
|
|
- unraid
|
|
- cross-platform
|
|
- key: audienceExperience
|
|
label: Audience experience
|
|
description: Describe the expected experience level of the people using the resulting guidance.
|
|
type: enum
|
|
required: true
|
|
sensitive: false
|
|
includeInOutput: true
|
|
default: new-to-project
|
|
options:
|
|
- new-to-project
|
|
- intermediate
|
|
- experienced
|
|
compatibility:
|
|
repositoryRequired: true
|
|
languages: []
|
|
frameworks: []
|
|
packageManagers: []
|
|
databases: []
|
|
deploymentTypes: []
|
|
requiredProfileCapabilities: []
|
|
incompatibleConditions: []
|
|
guardrails:
|
|
- id: guardrail-1
|
|
severity: blocking
|
|
text: Do not invent setup commands, credentials, URLs or environment values.
|
|
- id: guardrail-2
|
|
severity: blocking
|
|
text: Verify commands in a safe local or container context before documenting them as working.
|
|
- id: guardrail-3
|
|
severity: blocking
|
|
text: Use placeholders for secrets and explain how operators should provide them.
|
|
workflow:
|
|
- id: read-current-docs
|
|
title: Assess current guidance
|
|
instruction: Compare existing README, setup, deployment and contribution instructions with actual manifests and code.
|
|
required: true
|
|
- id: derive-prerequisites
|
|
title: Derive prerequisites
|
|
instruction: Identify supported platforms, required runtimes, services, environment variables and external tools.
|
|
required: true
|
|
- id: verify-setup
|
|
title: Verify clean setup
|
|
instruction: Run the documented or inferred clean setup path in a fresh environment where available.
|
|
required: true
|
|
- id: document-architecture
|
|
title: Document working model
|
|
instruction: Explain repository structure, main flows, common commands and debugging entry points for the selected audience.
|
|
required: true
|
|
- id: add-troubleshooting
|
|
title: Add troubleshooting
|
|
instruction: Document evidenced failure modes and recovery steps without presenting guesses as facts.
|
|
required: true
|
|
- id: review-clean-room
|
|
title: Review as newcomer
|
|
instruction: Check that a new contributor can progress from clone to verified smoke flow without private knowledge.
|
|
required: true
|
|
validation:
|
|
commandRoles:
|
|
- install
|
|
- build
|
|
- smoke-test
|
|
checks:
|
|
- id: check-1
|
|
type: assertion
|
|
description: Fresh-clone setup commands are verified or explicitly marked unverified.
|
|
blocking: true
|
|
evidence: Referenced files, command results or explicit review notes.
|
|
- id: check-2
|
|
type: assertion
|
|
description: The guide includes prerequisites, architecture, common tasks, testing and troubleshooting.
|
|
blocking: true
|
|
evidence: Referenced files, command results or explicit review notes.
|
|
- id: command-install
|
|
type: command
|
|
description: Run the resolved install command when the repository profile provides it and record the result.
|
|
blocking: true
|
|
evidence: Resolved command, exit status and concise result summary.
|
|
- id: command-build
|
|
type: command
|
|
description: Run the resolved build command when the repository profile provides it and record the result.
|
|
blocking: true
|
|
evidence: Resolved command, exit status and concise result summary.
|
|
- id: command-smoke-test
|
|
type: command
|
|
description: Run the resolved smoke-test command when the repository profile provides it and record the result.
|
|
blocking: true
|
|
evidence: Resolved command, exit status and concise result summary.
|
|
completion:
|
|
criteria:
|
|
- Fresh-clone setup is documented from verified commands.
|
|
- Architecture, common tasks and troubleshooting are included.
|
|
- Validation evidence and unresolved limitations are reported honestly.
|
|
failurePolicy:
|
|
onValidationFailure: Investigate failures caused by the current work, repair them when they remain within scope, rerun
|
|
affected validation and report any genuine blocker without claiming success.
|
|
onAmbiguity: Use repository evidence and existing conventions for minor reversible choices. Preserve current behavior
|
|
and stop before any material irreversible decision that the specification does not resolve.
|
|
onMissingContext: Inspect the repository for missing non-sensitive context. Never invent commands, credentials, production
|
|
behavior or validation results; report what remains unavailable.
|
|
onOutOfScopeCause: Explain the evidenced out-of-scope cause, avoid unrelated changes and provide the smallest safe follow-up
|
|
recommendation.
|
|
onExternalDependencyUnavailable: Use an approved local substitute or fixture only when it preserves the behavior under
|
|
test. Otherwise record the blocked validation and do not claim the external path succeeded.
|
|
onUnableToReproduce: Record attempted reproduction, environment and observed evidence. Do not apply speculative production
|
|
changes; provide the narrowest next diagnostic action.
|
|
reporting:
|
|
sections:
|
|
- id: outcome
|
|
title: Outcome
|
|
required: true
|
|
description: State the delivered result or audit conclusion without overstating evidence.
|
|
- id: evidence
|
|
title: Evidence and scope
|
|
required: true
|
|
description: List inspected or changed areas and the evidence supporting the result.
|
|
- id: validation
|
|
title: Validation
|
|
required: true
|
|
description: Report commands, manual checks and their actual outcomes.
|
|
- id: risks
|
|
title: Risks and limitations
|
|
required: true
|
|
description: State residual risk, inaccessible evidence and untested conditions.
|
|
- id: follow-up
|
|
title: Recommended follow-up
|
|
required: true
|
|
description: List the smallest useful next actions or state None.
|
|
template:
|
|
main: prompt.md
|
|
partials: []
|
|
exports:
|
|
prompt: true
|
|
markdown: true
|
|
runPack: true
|
|
agentsSuggestion: true
|
|
quality:
|
|
reviewStatus: editorial-reviewed
|
|
testedStacks: []
|
|
knownLimitations:
|
|
- Repository-specific effectiveness depends on the accuracy of the selected profile and the evidence available to Codex.
|
|
evaluationCaseIds:
|
|
- onboarding-documentation.static-structure
|