Jump to content

NixOS Wiki:Contributing: Difference between revisions

no edit summary
imported>Ixxie
(Added accessibility to language style guide.)
imported>Ixxie
No edit summary
Line 25: Line 25:


NixOS Wiki articles should be written in clear, standard and professional language. To this end, the following considerations apply:
NixOS Wiki articles should be written in clear, standard and professional language. To this end, the following considerations apply:
* ''Accessibility'': Wiki articles are often the first thing a new user will read about any subject, so they should be accessible to beginners.
; Accessibility: Wiki articles are often the first thing a new user will read about any subject, so they should be accessible to beginners.
* ''Vocabulary'': Use the simplest and most conventional words and expressions you can find to get your point across without oversimplifying.
; Vocabulary: Use the simplest and most conventional words and expressions you can find to get your point across without oversimplifying.
* ''Organization'': Keep your text structured in coherent sentences, paragraphs and sections, each with its own clear themes and topics.
; Organization: Keep your text structured in coherent sentences, paragraphs and sections, each with its own clear themes and topics.
* ''Citations'': Citations aren't required, but definitely appreciated; when citing code, hardlink to a particular revision.
; Citations: Citations aren't required, but definitely appreciated; when citing code, hardlink to a particular revision.
* ''Attribution'': Where external material is quoted or utilized in the article, and/or licensing or common sense demands it, place clear and complete attribution and (where possible) a link.
; Attribution: Where external material is quoted or utilized in the article, and/or licensing or common sense demands it, place clear and complete attribution and (where possible) a link.


=== Syntax ===
=== Syntax ===
Anonymous user