Purpose
The purpose of the STTF is to produce a one or more templates for formal specifications and a set of directives for the content and method of authoring of said documents along with the tooling to facilitate document drafting and review. This TF would operate under the purview of the TSWG, but is fully expected to be a polyglot TF having participation and contributions across all Working Groups in ToIP.
The STTF needs to provide directives for:
Document Format:
- Markdown (we currently require this format for documents going to WG/SC review)
- Kramdown
- something else
Document rendering:
- Spec-up
- Respec
- MKdocs
- something else
Document Structure:
What sections are required? Examples:
- Introduction
- Clauses (ISO) vs sections
- Bibliography
- Appendix vs Annex (ISO)
What sections are required and should be pre-populated? Examples:
- Foreword (ISO)
Status of This Memo (IETF)
- Copyright Notice (IETF)
Document Style:
- How should normative vs informative sections be distinguished?
- Do we require any Internationalization and localization of specifications?
- What format should references and citations have?
- Format and capitalization of terms and definitions
- iso lower cases all term definitions, but their usages can be capitalized, but not other formatting is applied
- IETF capitalizes terms and definitions and their usages... and sometimes italics/bold are applied (cite)
Document versioning:
- method
- publication deliverable / permanent links
Tooling:
- A set of GitHub actions that render publicly accessible:
- Webpages?
- Word documents?
- PDFs?
Documentation for paths to further SDOs:
- IETF
- ISO
- something else
(W3C is intentionally omitted as they have a well established feeder organization through the CCG)
The original deliverable template for reference:
https://docs.google.com/document/d/1LS8l5cv4ZVqpiqf39hU2KK5OpG5_ycZuLHGc6CumpfI/edit#heading=h.gjdgxs
Deliverables
The table below lists all deliverables of the ACDC Task Force:
| Acronym | Full Name of Deliverable | Deliverable Type | Link to Draft Deliverable | Lead Authors | Status/Notes |
|---|---|---|---|---|---|
| ST | Specification Template | Template | https://github.com/trustoverip/specification-template | Draft | |
| ... | Specification Style Guide | Guide | https://wiki.trustoverip.org/display/HOME/Specification+Style+Guide |
Proposed Chairs
Please add your name to this list if you wish to be a chair:
- Kevin Griffin Kevin Griffin
- Drummond Reed Drummond Reed
- ...
Meeting Schedule
Initial formal meeting then asynchronous, meeting as needed to gain consensus.
Meeting Agendas and Notes
TBD
Intellectual Property Rights (Copyright, Patent, Source Code)
As a Task Force (TF) of the Technology Stack WG (TSWG), the STTF inherits the IPR terms from the TSWG JDF Charter.
- Copyright mode: OWFa 1.0 (available at https://www.openwebfoundation.org/the-agreements/the-owf-1-0-agreements-granted-claims/owfa-1-0)
- Patent mode: OWFa 1.0 (available at https://www.openwebfoundation.org/the-agreements/the-owf-1-0-agreements-granted-claims/owfa-1-0)
- Source code: Apache 2.0 (available at http://www.apache.org/licenses/LICENSE-2.0.html)
Mailing List and Communications
This task force uses the following for communications
- Slack: This TF has its own dedicated Slack channel: #tswg-sttf
- Github: This TF will use GitHub issues for substantive conversations on topics, not Slack. This way the conversation is source controlled.