From f420412ff27d3705490bd646c9d53e94b44f7fc9 Mon Sep 17 00:00:00 2001 From: Jeff Horton <87995501+jeff-horton-ho-sas@users.noreply.github.com> Date: Fri, 20 Dec 2024 14:18:50 +0000 Subject: [PATCH] Make filename requirements explicit in writing-a-x standards (#490) * Make filename requirements explicit in standard/principle writing standards --- docs/standards/writing-a-principle.md | 6 ++++-- docs/standards/writing-a-standard.md | 4 +++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/standards/writing-a-principle.md b/docs/standards/writing-a-principle.md index 9754b9a7..92e04256 100644 --- a/docs/standards/writing-a-principle.md +++ b/docs/standards/writing-a-principle.md @@ -2,7 +2,7 @@ layout: standard order: 1 title: Writing a principle -date: 2023-08-04 +date: 2024-11-28 id: SEGAS-00002 tags: [] --- @@ -31,11 +31,13 @@ State the essence of the principle and make it easy to remember. Avoid ambiguous ```yaml layout: principle order: 1 -title: Example software engineering principle +title: Writing a principle tags: - Example ``` +The filename must be the kebab-cased title so that the principle's url matches its title. E.g. `writing-a-principle.md`. + ### A principle MUST have a description This description should be no longer than 2 paragraphs. It will be the first paragraph in the markdown file following the metadata. The reader should readily discern the answer to the question: "How does this affect me?". diff --git a/docs/standards/writing-a-standard.md b/docs/standards/writing-a-standard.md index 8c876822..1fc40db1 100644 --- a/docs/standards/writing-a-standard.md +++ b/docs/standards/writing-a-standard.md @@ -32,7 +32,7 @@ An unambiguous and unique identifier is needed for each standard. This provides layout: standard order: 1 title: Writing a standard -date: 2024-03-18 +date: 2024-11-28 id: SEGAS-00001 tags: - Example @@ -46,6 +46,8 @@ A short meaningful name is helpful to reference in conversation. Don't include w title: Writing a standard ``` +The filename must be the kebab-cased title so that the standard's url matches its title. E.g. `writing-a-standard.md`. + ### A standard MUST have a description An overview for each standard must be included. This will add high level information about the collection of requirements that make up the standard. This section will be used as a rationale for the standard as a whole.