Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| about:guidelines [2026/04/13 12:11] – klaus.kubeczko_ait.ac.at | about:guidelines [2026/04/29 14:18] (current) – vso_vso | ||
|---|---|---|---|
| Line 2: | Line 2: | ||
| <WRAP meta> | <WRAP meta> | ||
| - | version: 8.2 | + | version: 8.4 |
| updated: 8 April 2026 | updated: 8 April 2026 | ||
| status: published | status: published | ||
| Line 8: | Line 8: | ||
| <WRAP intro> | <WRAP intro> | ||
| - | This guide covers the principles, process, and standards that apply to every topic page. Please read this carefuly | + | This guide covers the principles, process, and standards that apply to every topic page. Please read this carefully |
| </ | </ | ||
| - | ===== Wiki principles | + | ===== Main ideas ===== |
| - | These principles apply to every topic page. | + | ==== Wiki principles ==== |
| + | |||
| + | These principles apply to how the wiki is developed and maintained. | ||
| <WRAP tablecap> | <WRAP tablecap> | ||
| Line 22: | Line 24: | ||
| ^ Principle ^ What it means in practice ^ | ^ Principle ^ What it means in practice ^ | ||
| | **Transparency** | All contributions, | | **Transparency** | All contributions, | ||
| - | | **Credibility** | Every factual claim requires a source. Prefer primary sources: original papers, official documents, standards. | | + | | **Credibility** | Every factual claim requires a source. Prefer primary sources, such as original papers, official documents, standards. | |
| - | | **Triangulation** | Every topic is developed from three perspectives (actors, technology, institutions), because no single discipline captures smart grid transitions on its own. | | + | | **Triangulation** | Every topic is developed from three perspectives (actors, technology, institutions). | |
| - | | **Scope** | State clearly whether a definition or claim is global, regional, | + | | **Scope** | State clearly whether a definition or claim used is applied universally |
| | **Accessibility** | Write for all Wiki audiences. Define technical terms on first use. | | | **Accessibility** | Write for all Wiki audiences. Define technical terms on first use. | | ||
| | **Knowledge integration** | Build on ISGAN tacit knowledge and publications as a shared baseline. Connect to broader literature where it expands the ISGAN framing. | | | **Knowledge integration** | Build on ISGAN tacit knowledge and publications as a shared baseline. Connect to broader literature where it expands the ISGAN framing. | | ||
| | **Critical reflexivity** | Mention many emerging literature that might challenge the current ISGAN framing. | | | **Critical reflexivity** | Mention many emerging literature that might challenge the current ISGAN framing. | | ||
| - | | **Feasible effort** | Quality | + | | **Feasible effort** | Quality |
| - | | **Referencing** | Use APA 7th edition. Include a DOI or stable URL where available. Verify all sources before submitting. Check markup guide for how to format references so that they appear as endnotes | | + | | **Referencing** | The wiki combines the use of APA 7th edition |
| - | | **Copyright** | For any image, confirm the licence | + | | **Copyright** | For any image, confirm the license |
| - | + | ||
| - | ===== The three perspectives ===== | + | |
| - | Smart grid transitions cannot be fully understood from any one disciplinary perspective. Engineering analysis reveals what is technically feasible. Institutional analysis explains what rules and incentives make certain options viable. | + | ==== The three perspectives ==== |
| - | Triangulation is a method | + | Smart grid transitions cannot be fully understood |
| - | Using multiple perspectives in combination makes it possible to understand phenomena in a more differentiated way: to identify priorities based on a fuller picture, to spot where different framings are compatible and where they conflict, and to develop options that are robust | + | Triangulation is a method from the social sciences for understanding real-world phenomena by combining multiple theoretical perspectives and methods. The aim is to compensate for the limitations of any single method and to strengthen the credibility of findings through convergence across different approaches. |
| <WRAP callout> | <WRAP callout> | ||
| - | A finding that holds across | + | A finding that holds across |
| </ | </ | ||
| - | {{:actor_institutions_technology_triangulation_transparent.jpg? | + | {{:0: |
| Every topic is explored from three perspectives. These are not separate sections to fill in independently; | Every topic is explored from three perspectives. These are not separate sections to fill in independently; | ||
| Line 52: | Line 52: | ||
| This perspective addresses the activities, views, interests and practices of the multiple groups whose actions shape smart grid transitions. | This perspective addresses the activities, views, interests and practices of the multiple groups whose actions shape smart grid transitions. | ||
| - | Actors such as energy suppliers, producers, aggregators, | + | Actors such as energy suppliers, producers, aggregators, |
| - | Key disciplines: | + | Key disciplines: |
| **Technologies and infrastructure** | **Technologies and infrastructure** | ||
| - | This perspective addresses the technical components, systems, and infrastructures that make up the electricity system, and the ways they can be configured to fulfil system functions. It covers generation, transmission, | + | This perspective addresses the technical components, systems, and infrastructures that make up the electricity system, and the ways they can be configured to fulfil system functions. It covers generation, transmission, |
| - | The technology perspective extends beyond hardware. | + | Interoperability standards, data exchange interfaces, metering systems, and control architectures are all within scope of the technology perspective. In smart grid the most consequential transitions are taking place in the cyber-physical realm, beyond hardware. |
| Key disciplines: | Key disciplines: | ||
| Line 66: | Line 66: | ||
| **Institutional structures** | **Institutional structures** | ||
| - | This perspective addresses the rules, regulations, | + | This perspective addresses |
| - | Understanding how open or resistant an institutional structure is to change is often as important as understanding the technical options available. | + | Understanding how open or resistant an institutional structure is to change is as important as understanding the technical options available. |
| - | Key disciplines: | + | Key disciplines: |
| </ | </ | ||
| - | ===== Tone and voice ===== | ||
| - | Topics should read as though written by a knowledgeable colleague explaining something clearly. It should be direct and precise, with focus on building shared understanding. | + | ===== Process ===== |
| - | **Language rules:** | + | ==== Roles ==== |
| - | * Use plain language. If a technical term is necessary, define it on first use. | + | |
| - | * Prefer active constructions: | + | |
| - | * Prefer //can// and //could// over //should// when describing possibilities. The wiki describes what institutions do and what options exist. It does not prescribe what countries ought to do. | + | |
| - | * Avoid hollow evaluative phrases: "a fundamental shift", | + | |
| - | * Avoid generic prose markers: "It is important to note that", "This section explores", | + | |
| - | * Avoid unnecessary introductions: | + | |
| - | * Vary sentence length for readability and flow; avoid overly long sentences. | + | |
| - | + | ||
| - | **Headings: | + | |
| - | + | ||
| - | ===== Roles ===== | + | |
| Wiki development is a co-creative process. Every topic has a small team. | Wiki development is a co-creative process. Every topic has a small team. | ||
| Line 102: | Line 90: | ||
| | **Reviewer** | Provides at least one round of structured feedback. Critical comments must be addressed before the topic advances. | | | **Reviewer** | Provides at least one round of structured feedback. Critical comments must be addressed before the topic advances. | | ||
| | **WG7 Task Lead** | Coordinates the overall editorial process, the Quality Review Panel, and publication logistics. | | | **WG7 Task Lead** | Coordinates the overall editorial process, the Quality Review Panel, and publication logistics. | | ||
| - | | **Communications Working Group** | Handles upload, promotional | + | | **Communications Working Group** | Promotional |
| - | | **Quality Review Panel** | Expert reviewers from at least three countries, with at least one outside the EU. Provides structured feedback during Stage 2. | | + | | **Quality Review Panel** | Expert reviewers from different |
| | **Inter-working group meeting** | Endorses the shared definition. Endorsement is required before a topic is published and again if the shared definition is subsequently changed. | | | **Inter-working group meeting** | Endorses the shared definition. Endorsement is required before a topic is published and again if the shared definition is subsequently changed. | | ||
| - | ===== Becoming a lead author | + | ==== Becoming a lead author ==== |
| Lead authors are the core of the wiki and every topic needs one. Lead authors take responsibility for a topic from first draft to publication: | Lead authors are the core of the wiki and every topic needs one. Lead authors take responsibility for a topic from first draft to publication: | ||
| Line 122: | Line 110: | ||
| **To propose a new topic:** See the [[about: | **To propose a new topic:** See the [[about: | ||
| - | ===== Editorial process | + | ==== Editorial process ==== |
| The process has three stages and three decision gates. Gate 1 is a lead author self-check before external review begins. Gate 2 is the substantive quality threshold before endorsement. | The process has three stages and three decision gates. Gate 1 is a lead author self-check before external review begins. Gate 2 is the substantive quality threshold before endorsement. | ||
| <WRAP callout> | <WRAP callout> | ||
| - | The inter-working group meeting endorses the shared definition only. All other content | + | The inter-working group meeting endorses the shared definition only. All other content |
| </ | </ | ||
| Line 144: | Line 132: | ||
| <WRAP checklist> | <WRAP checklist> | ||
| - | * ☐ The topic template is used, including the shared definition, three perspective subsections, | + | * ☐ The topic template is used, including the shared definition, three perspective subsections, |
| * ☐ Every factual claim has a source. Geographical scope is stated. Technical terms are defined on first use. | * ☐ Every factual claim has a source. Geographical scope is stated. Technical terms are defined on first use. | ||
| * ☐ Lead author and all co-authors are attributed in the metadata block. | * ☐ Lead author and all co-authors are attributed in the metadata block. | ||
| Line 178: | Line 166: | ||
| Milestone 3: Topic is ready for publication. | Milestone 3: Topic is ready for publication. | ||
| - | ===== Sensitivity rating ===== | + | ==== Topic status |
| - | Topics may be assigned sensitivity ratings, however how they should function | + | Each topic carries a status visible on the start page and on the topic page. The lead author is responsible for keeping it current. Only topics with status '' |
| + | |||
| + | <WRAP tablecap> | ||
| + | **Table 6.** Topic status values, transitions, | ||
| + | </ | ||
| + | |||
| + | ^ Status ^ Meaning ^ Enters when ^ Exits when ^ | ||
| + | | **Published** | Live and publicly visible. | Stage 4 upload | ||
| + | | **Under approval** | Quality review is complete; | ||
| + | | **In review** | Under editorial revision and quality panel review. Expert input is especially valuable at this stage. | Gate 1 is passed. | Gate 2 is passed. | | ||
| + | | **Draft** | Actively being written or undergoing major revision. | Work begins, or a major version bump is made. | Gate 1 is passed. | | ||
| + | | **Planned** | Content exists from an earlier wiki version but has not been updated to the current template and standards. | Old content is confirmed to exist. | Restructuring begins, moving the topic to '' | ||
| + | | **Backlog** | Topic identified; nothing written yet. | The topic is added to the registry. | Work begins, moving the topic to '' | ||
| - | ===== Versioning | + | ==== Versioning ==== |
| Every topic page carries a version number. The version and status move together at defined triggers. | Every topic page carries a version number. The version and status move together at defined triggers. | ||
| Line 202: | Line 202: | ||
| Start at version 1.0 on first publication. Update the version number and the updated date in the page metadata on every change. Use the optional topic notes section to record what changed between versions. | Start at version 1.0 on first publication. Update the version number and the updated date in the page metadata on every change. Use the optional topic notes section to record what changed between versions. | ||
| - | ===== Topic page structure ===== | + | ==== Sensitivity rating |
| - | Every topic page follows the same structure. Sections must appear in this order. | + | Topics may be assigned sensitivity ratings, however how they should function is still to be decided. At the moment no sensitivity ratings are assigned. |
| - | <WRAP tablecap> | + | ==== Comment system ==== |
| - | **Table 5.** Required sections for every topic page, in order. | + | |
| - | </ | + | |
| - | + | ||
| - | ^ # ^ Section ^ Purpose ^ | + | |
| - | | 1 | Category badge | Identifies which of the five categories this topic belongs to. | | + | |
| - | | 2 | Title | The topic name. | | + | |
| - | | 3 | Metadata block | Records lead authors, contributors, | + | |
| - | | 4 | Intro panel | One paragraph defining the topic and situating it in smart grid transitions. Every sentence must be specific to this topic. | | + | |
| - | | 4b | Insight block | A single plain-text sentence, 120–160 characters, no links or markup. Not visible on the topic page; feeds the topic card on the start page. | | + | |
| - | | 5 | Why this matters | One to two paragraphs and one callout box explaining why the topic matters for smart grid transitions. | | + | |
| - | | 6 | Shared definitions | The working definition, with an optional table for multi-dimensional concepts. | | + | |
| - | | 7 | Perspectives | Three subsections (Actors and stakeholders, | + | |
| - | | 8 | Distinctions and overlaps | Two to five entries clarifying what this topic is not, and where it borders adjacent concepts. | | + | |
| - | | 9 | Related topics | Direct links to other topic pages using '' | + | |
| - | | 10 | References | Full APA 7th edition, auto-generated from inline footnotes. | | + | |
| - | | 11 | Topic notes | Editorial working notes, gap log, AI attribution, | + | |
| - | + | ||
| - | For markup syntax and code examples for each section, see the [[about: | + | |
| - | + | ||
| - | ===== Topic status ===== | + | |
| - | + | ||
| - | Each topic carries a status visible on the start page and on the topic page. The lead author is responsible for keeping it current. Only topics with status '' | + | |
| - | + | ||
| - | <WRAP tablecap> | + | |
| - | **Table 6.** Topic status values, transitions, | + | |
| - | </ | + | |
| - | + | ||
| - | ^ Status ^ Meaning ^ Enters when ^ Exits when ^ | + | |
| - | | **Published** | Live and publicly visible. | Stage 4 upload is complete. | A major revision begins, returning the topic to '' | + | |
| - | | **Under approval** | Quality review is complete; the topic is awaiting endorsement at an inter-WG meeting. | Gate 2 is passed. | The shared definition is endorsed at an inter-WG meeting. | | + | |
| - | | **In review** | Under editorial revision and quality panel review. Expert input is especially valuable at this stage. | Gate 1 is passed. | Gate 2 is passed. | | + | |
| - | | **Draft** | Actively being written or undergoing major revision. | Work begins, or a major version bump is made. | Gate 1 is passed. | | + | |
| - | | **Planned** | Content exists from an earlier wiki version but has not been updated to the current template and standards. | Old content is confirmed to exist. | Restructuring begins, moving the topic to '' | + | |
| - | | **Backlog** | Topic identified; nothing written yet. | The topic is added to the registry. | Work begins, moving the topic to '' | + | |
| - | + | ||
| - | ===== Comment system | + | |
| Every topic page allows for comments from lead authors, contributors and reviewers within the main body of the text. | Every topic page allows for comments from lead authors, contributors and reviewers within the main body of the text. | ||
| Line 261: | Line 225: | ||
| * Mark a passage for follow-up after a meeting | * Mark a passage for follow-up after a meeting | ||
| - | ===== AI use ===== | + | |
| + | ===== Writing guidelines ===== | ||
| + | |||
| + | ==== Language, tone and voice ==== | ||
| + | |||
| + | Topics should read as though written by a knowledgeable colleague explaining | ||
| + | something clearly. It should be direct and precise, with focus on building | ||
| + | shared understanding. | ||
| + | |||
| + | **Language rules:** | ||
| + | * Use UK English spelling throughout. | ||
| + | * Use plain language. If a technical term is necessary, define it on first use. | ||
| + | * Prefer active constructions: | ||
| + | * Prefer can and could over should when describing possibilities. The wiki describes what is done and what options exist. It does not prescribe what countries ought to do. | ||
| + | * Avoid hollow evaluative phrases: "a fundamental shift", | ||
| + | * Avoid generic prose markers: "It is important to note that", "This section explores", | ||
| + | * Avoid unnecessary introductions: | ||
| + | * Vary sentence length for readability and flow; avoid overly long sentences. | ||
| + | * All section headings use sentence case. Write "Why this matters", | ||
| + | |||
| + | ==== Topic page structure ==== | ||
| + | |||
| + | Every topic page follows the same structure. Sections must appear in this order. | ||
| + | |||
| + | <WRAP tablecap> | ||
| + | **Table 5.** Required sections for every topic page, in order. | ||
| + | </ | ||
| + | |||
| + | ^ # ^ Section ^ Purpose ^ Word count ^ | ||
| + | | 1 | Category badge | Identifies which of the five categories this topic belongs to. | — | | ||
| + | | 2 | Title | The topic name. | — | | ||
| + | | 3 | Metadata block | Records lead authors, contributors, | ||
| + | | 4 | Intro panel | One paragraph defining the topic and situating it in smart grid transitions. Every sentence must be specific to this topic. | 80–120 words | | ||
| + | | 4b | Insight block | A single plain-text sentence, 120–160 characters, no links or markup. Not visible on the topic page; feeds the topic card on the start page. For backlog and planned topics, leave the block structurally present but empty. | 120–160 characters | | ||
| + | | 5 | Why this matters | One to two paragraphs and one callout box explaining why the topic matters for smart grid transitions. | 150–250 words | | ||
| + | | 6 | Shared definitions | The working definition, with an optional table for multi-dimensional concepts. | 80–150 words | | ||
| + | | 7 | Perspectives | Three subsections (Actors and stakeholders, | ||
| + | | 8 | Distinctions and overlaps | Two to five entries clarifying what this topic is not, and where it borders adjacent concepts. | 30–60 words per entry | | ||
| + | | 9 | Related topics | Direct links to other topic pages using '' | ||
| + | | 10 | References | Auto-generated from inline DokuWiki footnotes placed throughout body text. No section heading required. | — | | ||
| + | | 11 | Topic notes | Editorial working notes, gap log, AI attribution, | ||
| + | |||
| + | For markup syntax and code examples for each section, see the [[about: | ||
| + | |||
| + | ==== AI use ==== | ||
| AI tools may be used in wiki development when helpful, but their use is not required or expected. Where AI is used, it can help reorganise source material into the template structure, improve sentence flow, reformat references, or convert approved documents into DokuWiki markup. | AI tools may be used in wiki development when helpful, but their use is not required or expected. Where AI is used, it can help reorganise source material into the template structure, improve sentence flow, reformat references, or convert approved documents into DokuWiki markup. | ||
| Line 292: | Line 300: | ||
| .vh-entry .vh-body p: | .vh-entry .vh-body p: | ||
| </ | </ | ||
| + | <details class=" | ||
| + | < | ||
| + | <div class=" | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| <details class=" | <details class=" | ||
| < | < | ||
| Line 301: | Line 315: | ||
| < | < | ||
| <div class=" | <div class=" | ||
| - | < | + | < |
| </ | </ | ||
| </ | </ | ||
| Line 331: | Line 345: | ||
| < | < | ||
| <div class=" | <div class=" | ||
| - | < | + | < |
| </ | </ | ||
| </ | </ | ||