D2.2 Documentation Plan for OSPO‑RADAR
Year: 2026
Type: article
Abstract: The OSPO-RADAR project develops the technical tooling that enables Academic Open-Source Programme Offices (OSPOs) to archive, manage and showcase their institutions’ software, built on integration with Software Heritage. OSPO-RADAR will be offered both as a hosted service operated by Software Heritage and as free software that institutions can host themselves. D2.2 sets out how the product’s user documentation will be implemented for both settings. It compares two options: adding the documentation to the existing Software Heritage documentation website, or keeping it independent on the product’s own website. It recommends independent documentation built with Zensical, a Markdown-based static site generator, which also serves as a test case for a possible future migration of the Software Heritage documentation. The plan defines three content phases (API and system administration, institution setup, and curation and maintenance), a task-oriented help-centre content structure, and the scope of the API reference. Content development can begin now, while the software is still being developed.
Author: Draper, Melissa
Institution: Software Heritage
Language: English
Subfield: Information Systems
Field: Computer Science
Domain: Physical Sciences
Open Access status: green
OpenAlex ID: W7225660552
FWCI:
Cites:
Cited by:
Related to: