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
-42
@@ -6,6 +6,7 @@ schema: types/entity.schema.yaml
|
||||
subtype_field: entity_type
|
||||
base_dir: entities
|
||||
page_ref_fields: [related, sources]
|
||||
guidance: types/entity.guidance.md
|
||||
layout:
|
||||
project: {dir: projects, title: Projekte}
|
||||
system: {dir: systems, title: Systeme}
|
||||
@@ -16,31 +17,10 @@ layout:
|
||||
|
||||
# Entity
|
||||
|
||||
`entity` is the type for concrete things: projects, systems, tools, technologies or people. Entities are the primary building blocks of the knowledge graph.
|
||||
|
||||
<!-- wikitool:toc -->
|
||||
## Contents
|
||||
|
||||
- [When to use](#when-to-use)
|
||||
- [When NOT to use](#when-not-to-use)
|
||||
- [Frontmatter](#frontmatter)
|
||||
- [Authoring guidance](#authoring-guidance)
|
||||
- [Template](#template)
|
||||
<!-- /wikitool:toc -->
|
||||
|
||||
## When to use
|
||||
|
||||
- Representing a software project, an initiative or a piece of work
|
||||
- Documenting a running system, service or infrastructure component
|
||||
- Describing a CLI tool, utility or software library
|
||||
- Recording information about a language, a framework or a protocol
|
||||
- Documenting a person, a team or an organization
|
||||
|
||||
## When NOT to use
|
||||
|
||||
- For abstract concepts, patterns or methodologies (use `concept`)
|
||||
- For source documents or ingested material (use `source`)
|
||||
- For comparative analyses (use `comparison`)
|
||||
This instance's configuration for the `entity` type: its frontmatter fields as this schema
|
||||
requires them, and the page skeleton `wikitool new entity` scaffolds. When to use this type and
|
||||
how to write a conforming page is [types/entity.guidance.md](entity.guidance.md) -
|
||||
`tools/wikitool types describe entity` composes both into one answer.
|
||||
|
||||
## Frontmatter
|
||||
|
||||
@@ -56,15 +36,6 @@ layout:
|
||||
| `provenance` | Yes | sourced, general or mixed |
|
||||
| `summary` | Yes | One-liner for `kb/index.md` |
|
||||
|
||||
## Authoring guidance
|
||||
|
||||
- The title is the entity's canonical name and follows the subject's established designation, not the KB language (`kb/CONTRACT.md` § "Titles are identifiers", `kb/CONVENTIONS.md` §§ "Naming" and "Language")
|
||||
- The main description goes near the top
|
||||
- Link to related entities and concepts wherever relationships exist
|
||||
- Under `provenance: sourced` or `mixed`, back hard facts inline with a `[^cite-id]` footnote -
|
||||
`tools/wikitool cite add --page "<Title>" --source "Source - X"` mints the id and its definition
|
||||
- Wikipedia register: factual, neutral, no marketing language
|
||||
|
||||
## Template
|
||||
|
||||
The block below is page material, so it is written in this instance's KB language
|
||||
@@ -102,11 +73,3 @@ The relationships section is deliberately **not** in the template: it is a gener
|
||||
`wikitool xref` creates between markers on the first edge entry and re-renders from `related:`.
|
||||
An author never writes into it. The value behind `**Typ:**` stays the English enum value - that is
|
||||
what `search --field` filters on.
|
||||
|
||||
---
|
||||
|
||||
Additional notes:
|
||||
|
||||
- Entity pages form the concrete inventory of the knowledge base
|
||||
- Every entity type (project, system, tool and so on) is a variant of this base type
|
||||
- The relationships between entities carry the knowledge graph's interconnection
|
||||
|
||||
Reference in New Issue
Block a user