no way to compare when less than two revisions
Differences
This shows you the differences between two versions of the page.
Previous revisionLast revision | |||
— | wiki:best_practices [2022/03/14 12:10] – Cleaned up the wiki guidelines, added manual links, and added a section about tagging. Andre | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== Best Practices ====== | ||
+ | Follow these guidelines when editing the wiki. | ||
+ | |||
+ | ===== How to Use DokuWiki ==== | ||
+ | |||
+ | [[https:// | ||
+ | |||
+ | [[https:// | ||
+ | |||
+ | ===== Creating Pages ===== | ||
+ | |||
+ | [[https:// | ||
+ | |||
+ | * Begin page with H1 section. | ||
+ | * Capitalize the page title properly. Unsure? Use AMA style at: [[https:// | ||
+ | * Add a summary of the page after the title. | ||
+ | * End the page with an H2 "See Also" section that, at a minimum, has a link back to the parent page. | ||
+ | * Use the " | ||
+ | * Do not write comments onto the actual page. | ||
+ | * Use your user page for experimentation. | ||
+ | * Do not experiment on the page, and don't experiment in the playground or sandbox. | ||
+ | |||
+ | |||
+ | ===== Namespaces ===== | ||
+ | Namespaces are the wiki sections that pages live in. | ||
+ | |||
+ | [[https:// | ||
+ | |||
+ | * Create pages in the proper namespace. | ||
+ | * Do not create pages in the root (:) namespace | ||
+ | * Try to use existing namespaces for new pages (see: [[wiki: | ||
+ | * If you must create a new namespace | ||
+ | * Use short singular names (e.g., " | ||
+ | * Create a namespace: | ||
+ | * Tip: use the [[https:// | ||
+ | |||
+ | |||
+ | ===== Tagging ===== | ||
+ | Tag your pages using the tag [[https:// | ||
+ | |||
+ | * Page tags should be: | ||
+ | * Lowercase | ||
+ | * Singular, not plural | ||
+ | * Have a tag for overall page topic (e.g., fidonet, mail_server) | ||
+ | * Have a tag for the type of page (e.g., customization, | ||