Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
---
identity:
company: DevFactory
version: 2.0
#
# This document represents an L1 specification which describes in thorough
# technical detail a single Milestone; it can consist of a single file, or
# multiple files, imported via referencing.
#
# Syntax is [SpecL Markdown](https://...) (i.e. Markdown + Gherkin).
#
title: >
L1 Spec: {/Metadata/Product Name} -
{/Metadata/Release Name} -
M{/Metadata/Milestone Number}
header: >
L1 Spec: **Milestone {/Metadata/Milestone Number}**
Release {/Metadata/Release Name}
{/Metadata/Product Name}
footer: >
L1 schema version {schema: version} - Author: {/Metadata/Owner | "Unknown"} - {schema: company | "DF"}
schema:
#
# This is expected to be the first section of the Spec and it contains
# complete identification information.
#
Metadata:
# Short Capitalized Product Name.
Product Name: "..."
# Usually a version number, but can be a name also.
Release Name: 1.0
# (optional) Link to the parent L2 Spec (if any).
L2 Spec Link: "https://..."
# A simple integer denoting the milestone count.
Milestone Number: 1.0
# A name for this milestone.
Milestone Name: "SomeId"
# A ticket code, such as JIRA-123.
JIRA Ticket: "..."
# spec-author@email.here
Owner: "..."
# URI always pointing to the original spec.
Original: "..."
#
# Complete this list to introduce any acronyms or jargon used in this spec.
#
Glossary:
-
Term: ET1
Definition: Example Term 1
-
Term: ET2
Definition: Example Term 2
#
# Capabilities fall into a number of different Capability Types. This is expected
# to expand over time as our product management and engineering practices evolve.
# Any TPM should feel empowered to define a new capability type and template and
# add it to this repository.
#
Capabilities:
-
Summary: API provides endpoint for searching items.
Definition: >
{file(./caps/1-api-can-search-items.md)}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.