Guidelines for Creating New Pages

Welcome to the rules for creating new pages in our DokuWiki! Please follow these guidelines carefully to maintain consistency, clarity, and usability across our documentation.

• Namespace Structure: All new pages must be created within a namespace.
  • First Level Namespace: Use the manufacturer or platform name (e.g., `cisco`, `windows`, `linux`).
  • Second Level Namespace: Specify the specific device, product, or platform’s highest-level module (e.g., `router2900`, `server2019`, `kernel5`).
  • Third Level Namespace: Define the type of content on the page (e.g., `manual`, `troubleshooting`, `installation`).
  • Example: `cisco:router2900:installation_guide`
• Descriptive Titles: Beyond the namespaces, titles should describe the content clearly.
• Use Lowercase Letters: Except for proper nouns or acronyms.
• Avoid Special Characters: Stick to alphanumeric characters and underscores.

• Use Headings: Organize content using `======` for main titles and `=====`, `====`, etc., for subsections.
• Bullet Points & Tables: Use lists and tables for clarity whenever possible.
• Consistent Style: Write in a neutral tone, and use the active voice for clarity.

• Ensure Accuracy: Verify all information before adding it to the page.
• Citations: Provide links or references where appropriate.
• No Duplicates: Check if a similar page already exists before creating a new one.

• Use Page Templates: For specific types of content (e.g., FAQs, guides), use the pre-defined templates.
• Link to Templates: Include a link to available templates here (e.g., `example_template`).

• Tagging: Use relevant tags for easy navigation and searchability.
• Categories: Assign the page to the appropriate category.

• Peer Review: Ask a colleague to review the page for accuracy and formatting.
• Preview Before Publishing: Use the “Preview” function to ensure everything looks correct.
• Approval: Submit for approval if required by your team's workflow.

• Updates: Regularly update pages to keep them current.
• Clean-Up: Remove outdated or redundant information.

Here’s an example of a well-formatted new page:

• Title: `cisco:router2900:troubleshooting_guide`
• Content: Clear headings, concise explanations, and relevant tags.

By following these rules, we ensure our DokuWiki remains an efficient and user-friendly resource for everyone.

Happy documenting!