Skip to content

About

FPSOT diagrams specification

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

FPSOT diagrams specification

Rules for diagrams in FPSOT repositories: diagrams as PlantUML code, C4 views for architecture, UML 2.5.1 for structure and behavior, BPMN 2.0.2 for business processes, data model diagrams generated from LinkML, text alternatives, color, SVG output, file names, and diagrams in English and French. Accessibility rules and values come from the FPSOT accessibility specification. Version 0.1 is a draft.

Implement this spec

Read the normative text in spec/en/ or spec/fr/. Start with index.adoc, then read the five parts. Each requirement has an ID from DIA-001 to DIA-044. Check each diagram of your repository against every MUST rule. The shared diagrams workflow of fpsot-org/GitHub-Actions renders the sources and checks the committed SVG files.

Adopt this spec

Read the guide in docs/modules/en/pages/index.adoc or docs/modules/fr/pages/index.adoc. It shows one small PlantUML example per notation, and how to embed a diagram with its text alternatives. The comparison pages show how the practice of Canada and Québec relates to each requirement. To require the spec from a supplier, ask that every delivered diagram conforms to it.

Layout

Folder Content

spec/

Normative text, in English and French. book.adoc joins the pages into one book.

docs/

Guides, in the Antora folder layout.

skill/

The agent skill: a short summary that cites requirement IDs.

rules/

Machine-checkable rules. None yet.

diagrams/

PlantUML sources and their rendered SVG files: the example context diagram of the guide, in English and French.

jurisdictions/

Comparison data: the international baseline, Canada and Québec.

License

The specification is under the Community Specification License 1.0. Source code is under the Apache License 2.0. See LICENSE.md and NOTICE.

About

FPSOT diagrams specification

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors