Skip to main content
FOSDEM PWA

Managing Documentation Complexity: SEAPATH's Approach to Wiki Refactoring

UD2.208 (Decroly) | Day 1 | 14:10 - 14:25 | Speakers: Erwann Roussy

Managing Documentation Complexity: SEAPATH's Approach to Wiki Refactoring
A picture of a devroom at FOSDEM 2024
Open in browser

Notes

Abstract

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.

Attachments

Speakers

Erwann Roussy

Erwann graduated from Telecom Paris and is beginning his career with Savoir-faire linux. He is an active contributor and maintainer of the SEAPATH project. He is particularly interested in low-level development, system optimizations and open source philosophy

Notice: The placeholder video image is licensed under CC BY-SA 4.0. The original image can be found hereChanges made to the image are: Cropped the image to a new ratio, part of the image was cut off.