Introduction
Documentation is the backbone of any open-source project. Clear, accurate, and accessible docs reduce the learning curve, empower contributors, and accelerate adoption. Frappe already has a strong base with docs.frappe.io, but as the ecosystem grows (ERPNext, Framework, HRMS, LMS, CRM, Insights, Builder, etc.), keeping documentation consistent, up-to-date, and user-friendly has become critical.
To strengthen this effort, we propose the Documentation Working Group – a community-led initiative to bring structure, collaboration, and focus to documentation across the ecosystem.
Goals & Focus Areas
1. Content Creation & Updates
- Document every new feature and module at launch.
- Update pages to match the latest UI and workflows.
- Fill gaps (compliance, real-world workflows, troubleshooting).
2. Style & Standards
- Publish and maintain a Documentation Style Guide.
- Ensure consistent formatting, tone, screenshots, and terminology.
- Prepare for localization and accessibility improvements.
3. Tools & Contribution Workflow
- Improve contribution clarity with a step-by-step guide:
Current documentation contribution process
https://docs.frappe.io/framework/user/en/how_to_contribute
- Edit an existing page: Click Edit at the bottom → choose Markdown or Rich-Text editor.
- Add images: Upload via “Add Attachment” in markdown or paste/drag-drop in WYSIWYG.
- Submit edits: Preview → Submit → Wait for review (approve/reject/request changes).
- Create new pages: Use the New Page link in the sidebar, edit, and arrange if needed.
- Track contributions: Use the reviewer comments system to continue improving.(The Working Group will maintain this guide and keep it beginner-friendly.)
4. Community Engagement
- Onboard first-time contributors with mentorship and easy tasks.
- Organize documentation sprints tied to releases.
- Recognize and showcase community contributors.
5. Knowledge Expansion
- Add real-world examples, use cases, and playbooks.
- Maintain FAQs and troubleshooting guides based on forum discussions.
- Work with other WGs (Compliance, Framework, Local Meetups) to capture their knowledge in docs.
Who Can Join?
- Writers & Editors – To improve clarity and structure.
- Developers – To ensure accuracy of technical details.
- Consultants & Implementers – To share best practices and workflows.
- Students & New Contributors – A beginner-friendly way into open-source.
- Community Builders – To support translations, accessibility, and outreach.
How We Will Operate
This is something we want to finalize together as a community.
We invite all community members to share feedback, suggestions, and objections.
Based on the discussion here, we’ll shape and finalize the operating model for the Documentation Working Group.
For more context: https://discuss.frappe.io/t/restarting-community-collabration-with-working-groups-updates-from-frappeverse-25/153526