types/: Seiten-Type-Spec-Anleitungsprosa in stackeigene guidance-Datei ausgelagert (schliesst #104)
Files changed: - AGENTS.md - CHANGES.md - VERSION - docs/ownership-and-templates.md - instructions/migrations/6.0.0-type-guidance-split.md - instructions/setup-instance.md - tools/CONTRACT.md - tools/chemenu/commands/dist_cmd.py - tools/chemenu/commands/types_cmd.py - tools/chemenu/tests/test_dist_cmd.py - tools/chemenu/tests/test_dist_upgrade.py - tools/chemenu/tests/test_type_resolver.py - tools/chemenu/tests/test_types_cmd.py - tools/chemenu/type_resolver.py - tools/chemenu/types_core.py - types/comparison.guidance.md - types/comparison.md - types/concept.guidance.md - types/concept.md - types/entity.guidance.md - types/entity.md - types/source.guidance.md - types/source.md - types/type-guidance.md - types/type-guidance.schema.yaml - types/type-spec.md
This commit is contained in:
+5
-31
@@ -5,24 +5,15 @@ description: Structured type for comparison pages that set several entities or a
|
||||
schema: types/comparison.schema.yaml
|
||||
base_dir: comparisons
|
||||
page_ref_fields: [entities, related]
|
||||
guidance: types/comparison.guidance.md
|
||||
---
|
||||
|
||||
# Comparison
|
||||
|
||||
`comparison` is the type for pages that set several entities, tools, technologies or approaches systematically against one another along fixed criteria. Comparison pages support decisions and make the trade-offs between alternatives visible.
|
||||
|
||||
## When to use
|
||||
|
||||
- Comparing several technologies or frameworks for a concrete purpose
|
||||
- Analysing the advantages and disadvantages of different tools or libraries
|
||||
- Evaluating alternative ways of solving a problem
|
||||
- Documenting a decision process with several options examined
|
||||
|
||||
## When NOT to use
|
||||
|
||||
- For documenting a single entity or concept (use `entity` or `concept` respectively)
|
||||
- For summaries of source material (use `source`)
|
||||
- For pages covering a single subject rather than comparing several
|
||||
This instance's configuration for the `comparison` type: its frontmatter fields as this schema
|
||||
requires them, and the page skeleton `wikitool new comparison` scaffolds. When to use this type
|
||||
and how to write a conforming page is [types/comparison.guidance.md](comparison.guidance.md) -
|
||||
`tools/wikitool types describe comparison` composes both into one answer.
|
||||
|
||||
## Frontmatter
|
||||
|
||||
@@ -35,14 +26,6 @@ page_ref_fields: [entities, related]
|
||||
| `related` | No | Declared outbound edges - one `compares-with` edge per subject, written by `wikitool xref add` |
|
||||
| `summary` | Yes | One-liner for `kb/index.md` |
|
||||
|
||||
## Authoring guidance
|
||||
|
||||
- A title that names the comparison (e.g. "Go vs Rust", "Kubernetes vs Docker Swarm"); it follows the established names of the subjects compared, not the KB language (`kb/CONTRACT.md` § "Titles are identifiers", `kb/CONVENTIONS.md` §§ "Naming" and "Language")
|
||||
- State clearly what is being compared and why
|
||||
- Use a comparison table with the criteria as rows
|
||||
- An analysis that evaluates the table rather than repeating it
|
||||
- A recommendation wherever one can be justified
|
||||
|
||||
## Template
|
||||
|
||||
The block below is page material, so it is written in this instance's KB language
|
||||
@@ -75,12 +58,3 @@ TODO: Falls möglich - was wann und für wen zu verwenden ist. Unter welchen Ums
|
||||
convention, and the page title itself (`Go vs Rust`) does not carry it. When `wikitool xref` adds
|
||||
a relationship, the tool-managed cross-reference section appears; what it is called is the
|
||||
instance's decision in `kb/CONVENTIONS.md` (`sections:`).
|
||||
|
||||
---
|
||||
|
||||
Additional notes:
|
||||
|
||||
- Comparison pages support technology selection and architecture decisions
|
||||
- The entities compared should all exist as wiki pages
|
||||
- The criteria should fit the decision at hand
|
||||
- A comparison stays focused on one concrete purpose or decision context
|
||||
|
||||
Reference in New Issue
Block a user