Skip to content

Commit ade5d89

Browse files
rdmuellerrdmueller
authored
Merge pull request #12 from raifdmueller/fix/simple-consolidated-prompt
Fix #9: Simplify consolidated-system-prompt to single mega-prompt
2 parents 5ae6882 + 5d9fc72 commit ade5d89

1 file changed

Lines changed: 33 additions & 274 deletions

File tree

‎consolidated-system-prompt.adoc‎

Lines changed: 33 additions & 274 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,16 @@
1-
= Consolidated LLM System Prompts for Architecture Documentation
1+
= Consolidated System Prompt for Architecture Documentation
22
:toc: left
3-
:toclevels: 3
3+
:toclevels: 2
44
:sectanchors:
55
:sectlinks:
66
:sectnums:
77
:icons: font
88

9-
This document provides consolidated system prompts for creating specialized AI assistants focused on software architecture documentation using arc42, docToolchain, and related methodologies.
9+
This document provides a single, comprehensive system prompt that combines all architecture documentation capabilities into one mega-prompt for creating specialized AI assistants focused on software architecture documentation using arc42, docToolchain, and related methodologies.
1010

11-
== Overview
12-
13-
These prompts transform LLMs into expert architecture assistants that can:
14-
15-
* Structure architecture thinking systematically
16-
* Generate consistent, high-quality documentation
17-
* Follow established methodologies like arc42
18-
* Create visual diagrams and decision records
19-
* Maintain documentation as living artifacts
20-
21-
All prompts generate **AsciiDoc output** compatible with **docToolchain** workflows and include **PlantUML/C4 diagrams** for visual documentation.
22-
23-
== Complete Architecture Assistant (All Capabilities)
24-
25-
This mega-prompt combines all architecture documentation capabilities into a single comprehensive system prompt.
26-
27-
[source, markdown]
28-
----
29-
include::Architecture-Communication-Canvas.md[]
30-
31-
---
32-
33-
include::Architecture-Decision-Record.md[]
34-
35-
---
36-
37-
include::arc42-Chapter-Generator.md[]
38-
39-
---
40-
41-
include::Quality-Scenarios-Builder.md[]
42-
43-
---
44-
45-
include::Risk-Assessment-Matrix.md[]
46-
47-
---
48-
49-
include::Technical-Debt-Tracker.md[]
50-
51-
---
52-
53-
include::Stakeholder-Analysis.md[]
54-
55-
---
56-
57-
include::Context-Diagram-Generator.md[]
58-
59-
---
60-
61-
include::Solution-Strategy-Planner.md[]
62-
63-
---
64-
65-
include::Deployment-View-Creator.md[]
66-
----
67-
68-
== Core Architecture Tools Only
69-
70-
Essential tools for basic architecture documentation needs.
11+
== Complete Architecture Documentation Assistant
7112

13+
This consolidated prompt transforms LLMs into expert architecture assistants that can handle all aspects of software architecture documentation, from high-level strategic communication to detailed operational implementation.
7214
[source, markdown]
7315
----
7416
include::Architecture-Communication-Canvas.md[]
@@ -79,15 +21,6 @@ include::Architecture-Decision-Record.md[]
7921
8022
---
8123
82-
include::Quality-Scenarios-Builder.md[]
83-
----
84-
85-
== Comprehensive Documentation Suite
86-
87-
Full arc42 documentation capabilities with risk and debt management.
88-
89-
[source, markdown]
90-
----
9124
include::arc42-Chapter-Generator.md[]
9225
9326
---
@@ -101,37 +34,6 @@ include::Risk-Assessment-Matrix.md[]
10134
---
10235
10336
include::Technical-Debt-Tracker.md[]
104-
----
105-
106-
== Specialized Architecture Prompts
107-
108-
Advanced prompts for specific architecture concerns following arc42 chapters.
109-
110-
[source, markdown]
111-
----
112-
include::Stakeholder-Analysis.md[]
113-
114-
---
115-
116-
include::Context-Diagram-Generator.md[]
117-
118-
---
119-
120-
include::Solution-Strategy-Planner.md[]
121-
122-
---
123-
124-
include::Deployment-View-Creator.md[]
125-
----
126-
127-
== Quick Start Combinations
128-
129-
=== Architecture Overview Assistant
130-
For high-level architecture communication and stakeholder alignment.
131-
132-
[source, markdown]
133-
----
134-
include::Architecture-Communication-Canvas.md[]
13537
13638
---
13739
@@ -140,144 +42,44 @@ include::Stakeholder-Analysis.md[]
14042
---
14143
14244
include::Context-Diagram-Generator.md[]
143-
----
144-
145-
=== Strategic Planning Assistant
146-
For solution strategy and architectural decision making.
147-
148-
[source, markdown]
149-
----
150-
include::Quality-Scenarios-Builder.md[]
15145
15246
---
15347
15448
include::Solution-Strategy-Planner.md[]
15549
15650
---
15751
158-
include::Architecture-Decision-Record.md[]
159-
----
160-
161-
=== Operational Architecture Assistant
162-
For deployment and operational concerns.
163-
164-
[source, markdown]
165-
----
166-
include::Deployment-View-Creator.md[]
167-
168-
---
169-
170-
include::Risk-Assessment-Matrix.md[]
171-
172-
---
173-
174-
include::Technical-Debt-Tracker.md[]
175-
----
176-
177-
== Individual Prompts
178-
179-
=== Architecture Communication Canvas
180-
High-level architecture overview and stakeholder communication.
181-
182-
[source, markdown]
183-
----
184-
include::Architecture-Communication-Canvas.md[]
185-
----
186-
187-
=== Architecture Decision Record
188-
Structured architectural decision documentation with Pugh Matrix evaluation.
189-
190-
[source, markdown]
191-
----
192-
include::Architecture-Decision-Record.md[]
193-
----
194-
195-
=== arc42 Chapter Generator
196-
Complete arc42 documentation creation with quality-driven approach.
197-
198-
[source, markdown]
199-
----
200-
include::arc42-Chapter-Generator.md[]
201-
----
202-
203-
=== Quality Scenarios Builder
204-
Testable quality requirements using structured scenarios.
205-
206-
[source, markdown]
207-
----
208-
include::Quality-Scenarios-Builder.md[]
209-
----
210-
211-
=== Risk Assessment Matrix
212-
Systematic architecture risk identification and mitigation.
213-
214-
[source, markdown]
215-
----
216-
include::Risk-Assessment-Matrix.md[]
217-
----
218-
219-
=== Technical Debt Tracker
220-
Comprehensive technical debt identification and management.
221-
222-
[source, markdown]
223-
----
224-
include::Technical-Debt-Tracker.md[]
225-
----
226-
227-
=== Stakeholder Analysis
228-
Systematic stakeholder identification and communication planning.
229-
230-
[source, markdown]
231-
----
232-
include::Stakeholder-Analysis.md[]
233-
----
234-
235-
=== Context Diagram Generator
236-
System context diagrams following C4 Model Level 1 principles.
237-
238-
[source, markdown]
239-
----
240-
include::Context-Diagram-Generator.md[]
241-
----
242-
243-
=== Solution Strategy Planner
244-
Quality-driven solution strategies following arc42 Chapter 4.
245-
246-
[source, markdown]
247-
----
248-
include::Solution-Strategy-Planner.md[]
249-
----
250-
251-
=== Deployment View Creator
252-
Comprehensive deployment architectures following arc42 Chapter 7.
253-
254-
[source, markdown]
255-
----
25652
include::Deployment-View-Creator.md[]
25753
----
25854

25955
== Usage Instructions
26056

26157
=== For LLM Platforms
26258

263-
1. **Copy the desired prompt combination** from the source blocks above
59+
1. **Copy the complete prompt** from the source block above
26460
2. **Paste into your LLM interface** as a system prompt or initial message
265-
3. **Begin your architecture work** - the AI will guide you through structured processes
61+
3. **Begin your architecture work** - the AI will guide you through structured processes for any architecture documentation need
26662

26763
=== For AI Assistant Creation
26864

269-
1. **Select the appropriate combination** based on your needs:
270-
- **Complete Architecture Assistant**: All capabilities
271-
- **Core Tools**: Essential functionality only
272-
- **Specialized**: Advanced arc42-specific tools
273-
- **Quick Start**: Focused combinations for specific workflows
274-
275-
2. **Use as system prompts** in platforms like:
65+
1. **Use as system prompt** in platforms like:
27666
- Claude Projects (Anthropic)
27767
- GPTs (OpenAI)
27868
- Custom AI assistants
27969
- API implementations
28070

71+
2. **The AI will have comprehensive capabilities** for:
72+
- Architecture Communication Canvas creation
73+
- Architecture Decision Record documentation
74+
- Complete arc42 documentation generation
75+
- Quality scenarios and requirements definition
76+
- Risk assessment and mitigation planning
77+
- Technical debt identification and management
78+
- Stakeholder analysis and communication planning
79+
- System context diagram creation
80+
- Solution strategy development
81+
- Deployment architecture design
82+
28183
=== Integration with docToolchain
28284

28385
All generated outputs are designed to work seamlessly with docToolchain:
@@ -289,64 +91,32 @@ All generated outputs are designed to work seamlessly with docToolchain:
28991
./dtcw publishToConfluence
29092
```
29193

292-
== Prompt Characteristics
293-
294-
=== Consistent Style Elements
94+
== Capabilities Overview
29595

296-
All prompts in this collection share:
96+
The consolidated assistant provides:
29797

298-
* **Structured approach**: Step-by-step guided processes
299-
* **Quality focus**: Decisions tied to measurable quality goals
300-
* **Visual integration**: PlantUML/C4 diagrams embedded
301-
* **arc42 alignment**: Direct support for arc42 methodology
98+
* **Systematic approaches**: Each capability follows structured, step-by-step processes
99+
* **Quality focus**: All decisions tied to measurable quality goals
100+
* **Visual integration**: PlantUML/C4 diagrams embedded throughout
101+
* **arc42 alignment**: Direct support for arc42 methodology and chapter structure
302102
* **AsciiDoc output**: Compatible with docToolchain workflows
303103
* **Comprehensive templates**: Ready-to-use documentation structures
304-
305-
=== Interaction Patterns
306-
307-
* **Question-driven**: Prompts ask targeted questions to gather requirements
308-
* **Iterative refinement**: Support for multiple rounds of improvement
309-
* **Decision traceability**: Clear rationale for all architectural choices
310-
* **Stakeholder focus**: Consider multiple perspectives and communication needs
104+
* **Decision traceability**: Clear rationale linking requirements to architectural choices
311105
* **Implementation guidance**: Actionable next steps and validation approaches
312106

313-
=== Integration Benefits
314-
315-
When used together, these prompts provide:
316-
317-
* **End-to-end coverage**: From high-level strategy to operational implementation
318-
* **Consistent terminology**: Shared vocabulary across all documentation
319-
* **Traceability**: Clear links between different architectural concerns
320-
* **Workflow continuity**: Outputs from one prompt feed naturally into others
321-
* **Quality coherence**: Unified approach to quality-driven architecture
322-
323-
== Examples and Templates
324-
325-
=== Creating a Complete Architecture Documentation Set
107+
== Workflow Integration
326108

327-
1. **Start with Architecture Communication Canvas** - Get the big picture
328-
2. **Use Stakeholder Analysis** - Understand who needs what
329-
3. **Create Context Diagrams** - Establish system boundaries
330-
4. **Build Quality Scenarios** - Define measurable requirements
331-
5. **Develop Solution Strategy** - Bridge requirements to decisions
332-
6. **Document Architecture Decisions** - Capture key choices
333-
7. **Plan Deployment** - Address operational concerns
334-
8. **Assess Risks** - Identify and mitigate threats
335-
9. **Track Technical Debt** - Manage long-term code health
336-
337-
=== Typical Workflow Integration
109+
The assistant supports complete architecture documentation workflows:
338110

339111
```
340112
Stakeholder Analysis → Context Diagrams → Quality Scenarios
341-
↓
113+
↓
342114
Solution Strategy → Architecture Decisions → Deployment View
343-
↓
115+
↓
344116
Risk Assessment → Technical Debt Tracking → Documentation
345117
```
346118

347-
=== Output Integration
348-
349-
All prompts generate documentation that can be combined into comprehensive arc42 documentation:
119+
All outputs integrate seamlessly into comprehensive arc42 documentation covering:
350120

351121
* **Chapter 1**: Introduction and Goals (Architecture Communication Canvas)
352122
* **Chapter 3**: System Scope and Context (Context Diagram Generator)
@@ -356,17 +126,6 @@ All prompts generate documentation that can be combined into comprehensive arc42
356126
* **Chapter 10**: Quality Requirements (Quality Scenarios Builder)
357127
* **Chapter 11**: Risk and Technical Debt (Risk Assessment, Technical Debt Tracker)
358128

359-
== Contributing
360-
361-
To maintain consistency across all prompts:
362-
363-
1. **Follow the established style patterns** shown in existing prompts
364-
2. **Use consistent terminology** (AsciiDoc, arc42, PlantUML, etc.)
365-
3. **Maintain structured approaches** with clear step-by-step processes
366-
4. **Include visual elements** using PlantUML/C4 notation
367-
5. **Ensure quality focus** in all architectural decisions
368-
6. **Test integration** with other prompts in the collection
369-
370129
---
371130

372-
*These consolidated prompts provide a comprehensive toolkit for AI-assisted architecture documentation following arc42 methodology and docToolchain workflows.*
131+
*This consolidated prompt provides a comprehensive toolkit for AI-assisted architecture documentation following arc42 methodology and docToolchain workflows.*

0 commit comments

Comments
 (0)