meta:editing
Table of Contents
How to Be a Good Wiki Editor
Guidelines for contributing high-quality content to the folk.zone wiki.
Content Quality
- Be accurate - Verify information before adding it. If you are unsure, mark it as such or ask for clarification.
- Be specific - Use concrete examples and clear language. Avoid vague statements.
- Be concise - Keep pages focused on a single topic. Split large pages into smaller, more manageable sections.
- Be current - Update outdated information when you encounter it. Remove deprecated content when appropriate.
Writing Style
- Use plain language - Write as if explaining to someone with basic technical knowledge. Avoid unnecessary jargon.
- Be consistent - Follow existing formatting and naming conventions in the wiki.
- Use examples - Provide concrete examples to illustrate concepts.
- Link liberally - Connect related pages to help readers discover relevant content.
Technical Guidelines
- Follow the hygiene rules - Read and follow Wiki Hygiene Rules for community standards.
- Check bidirectional links - Ensure child pages link back to their parent namespaces. Run the link checking script regularly.
- Use proper formatting - Use DokuWiki syntax consistently. See DokuWiki Syntax for reference.
- Test your changes - Preview your edits before saving to catch formatting errors and broken links.
Collaboration
- Assume good faith - Assume other editors are trying to improve the wiki, even if you disagree with their changes.
- Discuss major changes - For significant rewrites or deletions, consider discussing first or leaving explanatory edit summaries.
- Be constructive - When editing others' work, improve rather than replace. Preserve their intent while fixing issues.
- Ask questions - If something is unclear, ask for clarification rather than making assumptions.
What Makes a Good Page
- Clear purpose - The page has a single, well-defined topic.
- Logical structure - Information is organized in a way that makes sense for the topic.
- Complete information - The page covers the topic adequately without unnecessary detail.
- Helpful links - The page connects to related topics and provides external references when appropriate.
- Actionable content - Readers can actually use the information provided.
Common Mistakes to Avoid
- Orphan pages - Pages that are not linked from anywhere else in the wiki.
- Overly broad topics - Pages that try to cover too much ground. Split these into smaller pages.
- Outdated information - Content that no longer reflects current reality.
- Missing context - Information that assumes knowledge the reader may not have.
- Broken links - Links to pages that do not exist or have been moved.
Getting Help
If you are unsure about how to edit or what to contribute:
- Check existing pages in the same namespace for examples
- Review What We're Looking For for content priorities
- Ask questions in the wiki discussion area or contact hello@folk.zone
See Also
meta/editing.txt · Last modified: by 127.0.0.1
