Managing Documentation Complexity: SEAPATH's Approach to Wiki Refactoring
- Track: Tool the Docs
- Room: UD2.208 (Decroly)
- Day: Saturday
- Start: 14:10
- End: 14:25
- Video only: ud2208
- Chat: Join the conversation!
LF Energy SEAPATH is an open source, high-availability real-time platform designed for hosting virtualized protection and control applications within electrical substations. As a complex project bridging electrical and computer engineering, it integrates multiple open source tools and expertise from diverse domains. Following the recent release of version 1.0, the project undertook a refactoring of its documentation to improve clarity and accessibility for a growing community of users and contributors
This talk will present the documentation strategy for such a complex project, highlighting the challenges encountered and the solutions implemented. Key discussion points include:
- Balancing documentation across multiple platforms: Ensure consistency and reduce redundancy between Confluence, GitHub, and Ansible Galaxy
- Structuring the wiki: Organize the information for diverse audiences
- Establishing clear naming conventions: A consistent terminology for pages, concepts, and components.
Speakers
| Erwann Roussy |