Manual of Style: Difference between revisions
mNo edit summary |
Agreed changes from https://github.com/NixOS/nixos-wiki-infra/issues/98 - part 1 of X |
||
| Line 6: | Line 6: | ||
<strong>This Manual of Style</strong> (hereinafter referred to as <strong>"MoS"</strong> or <strong>"MOS"</strong>) is designed to ensure that all content on the NixOS Wiki is presented in a clear and consistent manner. It provides guidelines on language usage, article structure, formatting, and other stylistic elements to maintain a high standard of quality across the wiki. This guide is intended for all contributors, whether they are new to editing or have extensive experience, to assist them in creating content that is both informative and accessible. | <strong>This Manual of Style</strong> (hereinafter referred to as <strong>"MoS"</strong> or <strong>"MOS"</strong>) is designed to ensure that all content on the NixOS Wiki is presented in a clear and consistent manner. It provides guidelines on language usage, article structure, formatting, and other stylistic elements to maintain a high standard of quality across the wiki. This guide is intended for all contributors, whether they are new to editing or have extensive experience, to assist them in creating content that is both informative and accessible. | ||
Editors | Technical writing is a skill that gets better with practice. This Manual of Style will help editors do that. It's OK to try to stick to it for the most part at first. A wiki thrives on all users helping each other to create better content. | ||
Editors should compose articles using language that is clear, concise, and readily comprehensible. Articles must be organized with consistent, reader-friendly layouts and formatting, as delineated in this guide. | |||
Any new content incorporated into this page must directly address a persistently recurring style issue. | Any new content incorporated into this page must directly address a persistently recurring style issue. | ||
| Line 12: | Line 14: | ||
== Rules of Thumb == | == Rules of Thumb == | ||
* <strong>Use Common Sense:</strong> Always apply logic and reason when contributing to the wiki. | * <strong>Use Common Sense:</strong> Always apply logic and reason when contributing to the wiki. | ||
* <strong>Cite Reliable Sources:</strong> | * <strong>Cite Reliable Sources:</strong> Aim to ensure that all information added is verifiable and comes from reliable sources. | ||
* <strong>Maintain Neutrality:</strong> Strive to present information in a neutral and unbiased manner. | * <strong>Maintain Neutrality:</strong> Strive to present information in a neutral and unbiased manner. | ||
* <strong>Be Clear and Concise:</strong> Use clear, concise, and grammatically correct language to ensure readability and understanding. | * <strong>Be Clear and Concise:</strong> Use clear, concise, and grammatically correct language to ensure readability and understanding. | ||
| Line 25: | Line 27: | ||
* <strong>Respect Others:</strong> Treat all users with respect and courtesy. Personal attacks and harassment are strictly prohibited. | * <strong>Respect Others:</strong> Treat all users with respect and courtesy. Personal attacks and harassment are strictly prohibited. | ||
* <strong>No Advertising, Vandalism, or Spamming:</strong> Contributions should be constructive and relevant. Any form of advertising, vandalism, or spamming will not be tolerated. | * <strong>No Advertising, Vandalism, or Spamming:</strong> Contributions should be constructive and relevant. Any form of advertising, vandalism, or spamming will not be tolerated. | ||
* '''Stay on Topic:''' This wiki is only about NixOS, Nixpkgs, Nix and the Nix-ecosystem. | |||
== Content Policy == | == Content Policy == | ||
| Line 34: | Line 37: | ||
* <strong>Definition:</strong> Plagiarism includes copying text, images, or other media without crediting the original source. | * <strong>Definition:</strong> Plagiarism includes copying text, images, or other media without crediting the original source. | ||
* <strong>Consequences:</strong> Plagiarized content will be removed immediately. Contributors who repeatedly plagiarize may be banned. | * <strong>Consequences:</strong> Plagiarized content will be removed immediately. Contributors who repeatedly plagiarize may be banned. | ||
* <strong>Prevention:</strong> Always cite your sources. Use quotation marks for direct quotes and provide proper references. | * <strong>Prevention:</strong> Always cite your sources. Use quotation marks for direct quotes and provide proper references. Don't just copy&paste a single sentence, but change it at least a little. | ||
=== Vandalism === | === Vandalism === | ||
| Line 92: | Line 95: | ||
6. References | 6. References | ||
==== Standard Section Structure ==== | ==== Standard Section Structure (Applications) ==== | ||
For consistency across the wiki, use the following structure where applicable: | For consistency across the wiki, use the following structure where applicable: | ||