admin/Templated-PPT-Master
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Link report structure and production guidance (0.8.0)

Browse Source
This commit is contained in:
Commilitia
2026-10-17 11:20:02 +08:00
parent 8943e7e5ae
commit 3b7de84c49
10 changed files with 91 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
references/text-and-containers.md
+6 -4
View File
@@ -51,17 +51,19 @@ Preserve separate paragraphs as separate complete strings or explicit paragraph
## Keep substantive explanations visible
Determine importance before assigning `caption`, `detail` or muted styles. Small muted text is for supplementary background, provenance and nonessential definitions. Key conditions, timing, dependencies, conclusions and interpretation-changing limitations belong in readable body, node, callout or heading roles. A qualifying statement is not supplementary merely because it sounds cautious.
Determine importance before assigning `caption`, `detail` or muted styles. Small muted text can carry background, data sources, data ranges, measurement definitions and citation details. A condition that directly changes the core conclusion or required action belongs with the related main information. Keep substantive chart explanations, key process conditions/timing, dependencies and conclusions readable as body, node text or a substantive callout heading.
Fix ambiguous or overstrong body text directly, supplement the evidence or integrate the necessary condition. Remove disclaimers that only anticipate hypothetical objections and add no useful understanding, judgment or action. A small note or warning box does not justify keeping an unnecessary statement. Retain concrete useful warnings with emphasis suited to their role; ordinary source and range notes do not need to become warnings.
| Statement | Treatment |
|---|---|
| Data source, collection date or a nonessential terminology expansion | Supplementary note is allowed; retain source metadata too |
| Data source, collection date, citation locator or supplementary range/measurement definition | Small supplementary text is allowed; retain source metadata too |
| “Only proceed after approval”, “retry after timeout” | Main process/node text; the viewer needs it to follow the process |
| “Method B is faster” | Main comparison/conclusion hierarchy |
| “Only measured on this dataset; does not establish general performance” | Visible limitation alongside the claim, not small muted text or speaker-notes-only |
| The measured dataset defines the scope of the core performance claim | State that scope in the claim or its related main information; detailed dataset provenance may remain small |
| A unit/definition that changes what a chart means | Keep it visibly associated with the chart at a suitable readable level |
Read the page without the small muted notes. Its workflow, conclusion and scope must still be accurate and complete. This check also applies to any field named `source`: the field name cannot make a substantive claim into provenance.
Read the page without the small muted notes. Its workflow, conclusion and necessary scope must remain understandable and accurate. Then check the notes for useful supporting detail rather than repeated disclaimers. This check also applies to any field named `source`: the field name cannot make a substantive claim into provenance.
## Different roles inside a container