Jump to content

Nanopore Wiki:Editorial guidelines: Difference between revisions

From Nanopore Wiki
Marked this version for translation
Shorten visible site name to Wiki
Tag: Reverted
Line 3: Line 3:


<!--T:2-->
<!--T:2-->
These guidelines describe how Nanopore Wiki pages should be written and maintained.
These guidelines describe how Wiki pages should be written and maintained.


== Core principles == <!--T:3-->
== Core principles == <!--T:3-->

Revision as of 11:42, 30 June 2026

Editorial guidelines

These guidelines describe how 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.