OSPO Frequently Asked Questions (FAQ) project

:license: CC BY 4.0 International
:project-uri: https://gitlab.eclipse.org/eclipse/plato/www/-/tree/main/content/faq

OSPO FAQ is an open source project dedicated to providing modular, field based, curated and generic Frequently Asked Question corpus to be used, adapted, personnalized by Open Source Program Office teams or any similar unformal role dedicated to driving open source strategy in an organization.

It is built as a text corpus by experienced experts and meant to be:

enriched by live experience from the community,
using AsciiDoc for ease of maintenance, modularity and collaboration,
curated by OSPO Alliance maintainers

Vision
Empower individuals, teams, and organizations in their open source strategy and governance, by providing a rich corpus of re-usable questions / answers, thus minimizing the time spent in providing support within their organization and enable any automation type of approach (intranet, bot, ..) to make OSPOs type roles more efficient and able to concentrate on business value priorities while proving a high quality support of their teams. Shared experience should also allow teams to find ready to use answers for new topics based on retex from others.

Philosophy
Key aspects of the OSPO FAQ project:

Resusable and modular questions & answers: Each topic / question is a standalone paragraph, easy to reuse and adapt.
Keep it simple, see how it answers to market needs and if necessary the project will increase sophistication (templates, config files, approval automation workflow)
All maturity level content: Purpose of the corpus is to cover basic to advanced questions both kick starting the FAQ approach as well as sharing more advanced or tricky questions.
Inner/Open Source: OSPO FAQ will address the full scope of Inner Source and Open Source.
Question & answers as Code: All material is written in Markdown (eventually AsciiDoc) for version-controlled, easily maintainable content. It also allows community based conversation to get to a shared, consensus based type of answer.
Tags / category: Provided as generic and focused list, tags and categories can evoluate to more sophisticated process (config files, automation workflows, ..) upon large enough community engagement and contributions.

Available FAQ Knowledge base

Nota: all questions are markdown files and can be exported from :project-uri: for re-use.
Nota(2): asciidoc format is in our roadmap to ease (re)editing to different formats.

How to contribute

Thank you for helping improve this FAQ. Contributions of all sizes are welcome — from fixing a typo to writing a new entry from scratch.

Before starting

Check open issues and existing entries to avoid duplicates.
If your question is not already covered or you want to propose some modification to an existing one, open an issue first using the entry format. This lets the community sort and ack the question before you write the full answer.

Writing style

Question as title. The title field must be a complete question ending with ?.
Short answer first. Open every entry with a one- or two-sentence summary. Detailed explanation follows.
Concrete examples. Prefer a short code block or command over a paragraph of abstract description.
Link to canonical sources. Prefer official documentation, RFCs, and SPDX over blog posts.
Neutral tone. Avoid opinionated recommendations unless consensus is clear and sourced. == Rules of review & approval OSPO Alliance will review formalized, qualitative issues or merge request based on limited bandwidth so your help and understanding are very welcome.

This project follows the Contributor Covenant. Be kind, be specific, be constructive.

License