Skip to content

Commit ca01e87

Browse files
authored
README content for the templates section (#60)
1 parent 8ee51bf commit ca01e87

File tree

1 file changed

+75
-0
lines changed
  • manual/2-populate-the-structure/templates

1 file changed

+75
-0
lines changed
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Templates
2+
3+
This directory contains templates to create new technical documents for Logos. Templates help maintain consistency and save time when creating similar types of content.
4+
5+
- [Quickstart template](./quickstart-template.md)
6+
- [Concept template](./concept-template.md)
7+
- [Procedure template](./procedure-template.md)
8+
- [Reference template](./reference-template.md)
9+
10+
## Using templates
11+
12+
Templates are Markdown files. To use a template, copy the desired template content and paste it into your new document. Then, fill in the relevant sections with your content.
13+
14+
> **Note:**
15+
>
16+
> Your content should follow the structure and guidelines provided in the template. Don't modify the template to fit your content. If you need to update a template, send a pull request with your changes following the [contribution guidelines](../../CONTRIBUTING.md).
17+
18+
## Guided vs. minimal templates
19+
20+
The templates in this section use a guided approach, providing detailed instructions and examples to help you structure your content effectively.
21+
22+
Unlike minimal templates, which offer only basic headings and leave much of the structure up to the author, guided templates are dense with content and may feel overwhelming at first. This initial density is intentional: it makes expectations explicit, prevents omissions, and typically shortens drafting and review time.
23+
24+
The rationale for using guided templates instead of minimal templates is twofold:
25+
26+
1. **Reduce context switching**: Minimize the need for authors to jump between resources (e.g., writing rules and examples) while drafting. Guided templates provide instructions and examples in one place.
27+
2. **Support inexperienced authors**: SMEs are typically not trained as technical writers. For highly technical content that is not frequently updated, guided templates are the most effective way to help inexperienced authors produce complete and clear documentation.
28+
This diagram illustrates this situation:
29+
30+
```mermaid
31+
%%{init: {
32+
"theme": "base",
33+
"themeVariables": {
34+
"fontFamily": "Inter, ui-sans-serif, system-ui, -apple-system, Segoe UI, Roboto",
35+
"fontSize": "14px",
36+
"primaryTextColor": "#0f172a",
37+
"lineColor": "#94a3b8"
38+
},
39+
"flowchart": { "curve": "basis", "nodeSpacing": 50, "rankSpacing": 60 }
40+
}}%%
41+
flowchart LR
42+
%% Groups
43+
subgraph Inputs
44+
direction TB
45+
A{Doc<br/>complexity?}:::decision
46+
B{Writer<br/>experience?}:::decision
47+
E{Update<br/>frequency?}:::decision
48+
end
49+
50+
subgraph Recommendation
51+
direction TB
52+
C([Lightweight<br/>template]):::good
53+
D([Feature-rich<br/>template]):::strong
54+
end
55+
56+
%% Flows
57+
A -- High --> B
58+
A -- Low --> C
59+
B -- New --> D
60+
B -- Experienced --> C
61+
E -- Often --> C
62+
E -- Rare --> D
63+
64+
%% (Optional) layout hint to keep Inputs aligned
65+
A -. Align -.-> E
66+
67+
%% Styles
68+
classDef decision fill:#eff6ff,stroke:#3b82f6,stroke-width:1.5px,color:#0f172a;
69+
classDef good fill:#ecfdf5,stroke:#10b981,stroke-width:1.5px,color:#064e3b;
70+
classDef strong fill:#f5f3ff,stroke:#8b5cf6,stroke-width:1.5px,color:#2e1065;
71+
72+
%% Link accents (green to "Lightweight", purple to "Feature-rich")
73+
linkStyle 1,3,4 stroke:#10b981,stroke-width:1.5px;
74+
linkStyle 2,5 stroke:#8b5cf6,stroke-width:1.5px;
75+
```

0 commit comments

Comments
 (0)