一键在 Manus 中运行任何 Skill

开始使用

openup-create-architecture-notebook

星标14

分支4

更新时间2026年7月2日 06:54

Generate or update architecture documentation from template

安装

用 Codex 或 Claude 帮你安装复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。

在 Manus 中运行

来源

GermanDZ

GermanDZ/open-up-for-ai-agents

打开 GitHub 仓库查看创作者相关仓库

下载

在 Manus 中运行

Create Architecture Notebook

This skill generates or updates an architecture notebook from the OpenUP template.

When to Use

Use this skill when:

Starting Elaboration phase and need to document architecture
Making significant architectural decisions
Need to document system design and constraints
Establishing architecture baseline
Reviewing or updating existing architecture

When NOT to Use

Do NOT use this skill when:

In Inception phase before architecture is defined (use /openup-create-vision)
Need detailed component design (use design documents)
Looking for implementation details (use code documentation)
Architecture notebook exists and only minor updates needed (edit directly)

Success Criteria

After using this skill, verify:

Architecture notebook exists at docs/architecture-notebook.md
System name and context are defined
Key architectural decisions are documented
Architectural constraints are listed
Quality attributes are specified
Subsystem/component decomposition is documented

Process

Load Project Config (context + rules — do this first)

If docs/project-config.yaml exists, apply it before drafting (skip if absent): inject its context: as <project-context> and its rules.architecture-notebook as <project-rules>, then confirm every injected rule holds before marking the artifact complete. Rules are additive — they may add but never waive a framework criterion. Full mechanism + precedence (the single source): docs-eng-process/project-config.md.

1. Check for Existing Architecture

Check if docs/architecture-notebook.md exists:

If yes, update it
If no, create from template

2. Read Project Context

Read docs/project-status.md, docs/vision.md to understand:

System requirements
Constraints
Stakeholder concerns

3. Copy Template (if new)

If creating new, copy docs-eng-process/templates/architecture-notebook.md to docs/architecture-notebook.md

4. Fill in Architecture Notebook

Update with:

System name: $ARGUMENTS[system_name]
Architectural concerns: From $ARGUMENTS[architectural_concerns] or derived from requirements
Architecture overview: High-level system architecture
Key architectural decisions: Rationale for major decisions
Constraints: Technical and business constraints
Quality attributes: Performance, security, scalability requirements
Subsystem decomposition: Major system components

4a. Write Instance Frontmatter (T-038 — doc traceability)

The architecture notebook holds a series of architectural decisions; for v1 we tag the notebook file as a single decision work-product instance that traces back to the project vision (per the v1 spine: decision → traces-from → vision). Per-decision ADR files are still welcome as additional decision instances under docs/decisions/ — each gets the same instance frontmatter, with a distinct id. Grade against the cross-cutting Doc Traceability Rubric.

Example block (replaces the template's provenance frontmatter):

---
type: decision              # required — v1 spine
id: D-01                    # stable, project-unique (notebook = first decision)
title: Architecture Notebook — <System Name>
status: approved
traces-from: [VIS-001]      # the vision this architecture serves
owner-role: architect
---

Field reference: docs-eng-process/doc-frontmatter.md. Validator: python3 scripts/check-docs.py.

5. Self-Critique

Apply the Self-Critique SOP (docs-eng-process/sops/self-critique.md) before validating: take a hostile-reviewer stance, surface every load-bearing assumption into the notebook, and confirm each architectural decision records the rejected alternatives and the constraint that forced it — not just the choice made. List every weakness you find — including ones you are uncertain about — then fix or explicitly flag each one. Rank them and record the top one or two with their resolutions.

6. Validate Completeness

Re-check every item in Success Criteria (top of this skill) against the document you produced; fix any gap before returning.

Output

Returns:

Path to architecture notebook
List of sections filled in
Architectural decisions documented

Common Errors

Error	Cause	Solution
Template not found	Template path incorrect	Verify `docs-eng-process/templates/architecture-notebook.md` exists
Insufficient context	Vision/requirements not defined	Create vision document first
Overwriting existing	Architecture notebook already exists	Update existing file instead of creating new

References

Architecture Notebook Template: docs-eng-process/templates/architecture-notebook.md
Architecture Notebook Work Product: docs-eng-process/openup-knowledge-base/practice-technical/evolutionary_arch/base/workproducts/architecture-notebook-6.md
Architect Role: docs-eng-process/openup-knowledge-base/core/role/roles/architect-6.md

Create Architecture Notebook

This skill generates or updates an architecture notebook from the OpenUP template.

When to Use

Use this skill when:

Starting Elaboration phase and need to document architecture
Making significant architectural decisions
Need to document system design and constraints
Establishing architecture baseline
Reviewing or updating existing architecture

When NOT to Use

Do NOT use this skill when:

In Inception phase before architecture is defined (use /openup-create-vision)
Need detailed component design (use design documents)
Looking for implementation details (use code documentation)
Architecture notebook exists and only minor updates needed (edit directly)

Success Criteria

After using this skill, verify:

Architecture notebook exists at docs/architecture-notebook.md
System name and context are defined
Key architectural decisions are documented
Architectural constraints are listed
Quality attributes are specified
Subsystem/component decomposition is documented

Process

Load Project Config (context + rules — do this first)

1. Check for Existing Architecture

Check if docs/architecture-notebook.md exists:

If yes, update it
If no, create from template

2. Read Project Context

Read docs/project-status.md, docs/vision.md to understand:

System requirements
Constraints
Stakeholder concerns

3. Copy Template (if new)

If creating new, copy docs-eng-process/templates/architecture-notebook.md to docs/architecture-notebook.md

4. Fill in Architecture Notebook

Update with:

System name: $ARGUMENTS[system_name]
Architectural concerns: From $ARGUMENTS[architectural_concerns] or derived from requirements
Architecture overview: High-level system architecture
Key architectural decisions: Rationale for major decisions
Constraints: Technical and business constraints
Quality attributes: Performance, security, scalability requirements
Subsystem decomposition: Major system components

4a. Write Instance Frontmatter (T-038 — doc traceability)

Example block (replaces the template's provenance frontmatter):

---
type: decision              # required — v1 spine
id: D-01                    # stable, project-unique (notebook = first decision)
title: Architecture Notebook — <System Name>
status: approved
traces-from: [VIS-001]      # the vision this architecture serves
owner-role: architect
---

Field reference: docs-eng-process/doc-frontmatter.md. Validator: python3 scripts/check-docs.py.

5. Self-Critique

6. Validate Completeness

Re-check every item in Success Criteria (top of this skill) against the document you produced; fix any gap before returning.

Output

Returns:

Path to architecture notebook
List of sections filled in
Architectural decisions documented

Common Errors

Error	Cause	Solution
Template not found	Template path incorrect	Verify `docs-eng-process/templates/architecture-notebook.md` exists
Insufficient context	Vision/requirements not defined	Create vision document first
Overwriting existing	Architecture notebook already exists	Update existing file instead of creating new

References

Architecture Notebook Template: docs-eng-process/templates/architecture-notebook.md
Architecture Notebook Work Product: docs-eng-process/openup-knowledge-base/practice-technical/evolutionary_arch/base/workproducts/architecture-notebook-6.md
Architect Role: docs-eng-process/openup-knowledge-base/core/role/roles/architect-6.md

name	openup-create-architecture-notebook
description	Generate or update architecture documentation from template
model	sonnet
arguments	[{"name":"system_name","description":"Name of the system","required":true},{"name":"architectural_concerns","description":"Key architectural concerns to address","required":false}]

name	openup-create-architecture-notebook
description	Generate or update architecture documentation from template
model	sonnet
arguments	[{"name":"system_name","description":"Name of the system","required":true},{"name":"architectural_concerns","description":"Key architectural concerns to address","required":false}]

openup-create-architecture-notebook

Create Architecture Notebook

When to Use

When NOT to Use

Success Criteria

Process

Load Project Config (context + rules — do this first)

1. Check for Existing Architecture

2. Read Project Context

3. Copy Template (if new)

4. Fill in Architecture Notebook

4a. Write Instance Frontmatter (T-038 — doc traceability)

5. Self-Critique

6. Validate Completeness

Output

Common Errors

References

See Also

Create Architecture Notebook

When to Use

When NOT to Use

Success Criteria

Process

Load Project Config (context + rules — do this first)

1. Check for Existing Architecture

2. Read Project Context

3. Copy Template (if new)

4. Fill in Architecture Notebook

4a. Write Instance Frontmatter (T-038 — doc traceability)

5. Self-Critique

6. Validate Completeness

Output

Common Errors

References

See Also

openup-create-architecture-notebook

Create Architecture Notebook

When to Use

When NOT to Use

Success Criteria

Process

Load Project Config (context + rules — do this first)

1. Check for Existing Architecture

2. Read Project Context

3. Copy Template (if new)

4. Fill in Architecture Notebook

4a. Write Instance Frontmatter (T-038 — doc traceability)

5. Self-Critique

6. Validate Completeness

Output

Common Errors

References

See Also

同仓库更多 Skills

同仓库更多 Skills

Create Architecture Notebook

When to Use

When NOT to Use

Success Criteria

Process

Load Project Config (context + rules — do this first)

1. Check for Existing Architecture

2. Read Project Context

3. Copy Template (if new)

4. Fill in Architecture Notebook

4a. Write Instance Frontmatter (T-038 — doc traceability)

5. Self-Critique

6. Validate Completeness

Output

Common Errors

References

See Also