Nanopore Wiki:Editorial guidelines: Difference between revisions
Fix language navigation label encoding |
Restore visible brand name to Nanopore Wiki Tag: Manual revert |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
< | <translate> | ||
= Editorial guidelines = <!--T:1--> | |||
= Editorial guidelines = | |||
<!--T:2--> | |||
These guidelines describe how Nanopore Wiki pages should be written and maintained. | These guidelines describe how Nanopore Wiki pages should be written and maintained. | ||
== Core principles == | == Core principles == <!--T:3--> | ||
<!--T:4--> | |||
* Write clearly for technical and non-technical readers. | * Write clearly for technical and non-technical readers. | ||
* Prefer reliable sources, including peer-reviewed literature, official documentation, and well-maintained reference resources. | * Prefer reliable sources, including peer-reviewed literature, official documentation, and well-maintained reference resources. | ||
| Line 13: | Line 14: | ||
* Keep wiki syntax valid, especially links, tables, templates, and translation units. | * Keep wiki syntax valid, especially links, tables, templates, and translation units. | ||
== Page structure == | == Page structure == <!--T:5--> | ||
<!--T:6--> | |||
A useful topic page should normally include a short definition, context, key concepts, applications, related pages, and references. | A useful topic page should normally include a short definition, context, key concepts, applications, related pages, and references. | ||
== Research updates == | == Research updates == <!--T:7--> | ||
<!--T:8--> | |||
Items in [[Latest Progress]] should include a date, concise summary, and source link. Important updates can later be expanded into standalone topic pages. | Items in [[Latest Progress]] should include a date, concise summary, and source link. Important updates can later be expanded into standalone topic pages. | ||
== Translations == | == Translations == <!--T:9--> | ||
<!--T:10--> | |||
Translations should preserve wiki structure and translate visible text only. Do not alter link targets, template syntax, table markers, or file names unless there is a clear reason. | Translations should preserve wiki structure and translate visible text only. Do not alter link targets, template syntax, table markers, or file names unless there is a clear reason. | ||
</translate> | |||
<languages /> | |||
Latest revision as of 11:47, 30 June 2026
Editorial guidelines
These guidelines describe how Nanopore Wiki pages should be written and maintained.
Core principles
- Write clearly for technical and non-technical readers.
- Prefer reliable sources, including peer-reviewed literature, official documentation, and well-maintained reference resources.
- Distinguish facts, interpretation, hypotheses, and opinion.
- Avoid unsupported claims, promotional language, and unnecessary jargon.
- Keep wiki syntax valid, especially links, tables, templates, and translation units.
Page structure
A useful topic page should normally include a short definition, context, key concepts, applications, related pages, and references.
Research updates
Items in Latest Progress should include a date, concise summary, and source link. Important updates can later be expanded into standalone topic pages.
Translations
Translations should preserve wiki structure and translate visible text only. Do not alter link targets, template syntax, table markers, or file names unless there is a clear reason.