From 822ce4ada93f60b38c799e254b09253c62481ff8 Mon Sep 17 00:00:00 2001 From: apenzk Date: Thu, 27 Mar 2025 15:05:20 +0100 Subject: [PATCH 1/3] file --- .github/CODEOWNERS | 2 +- MD/md-n/README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++ md-template.md | 2 +- 3 files changed, 51 insertions(+), 2 deletions(-) create mode 100644 MD/md-n/README.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 2de60dcd..ebf7f92f 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -20,8 +20,8 @@ /MIP/mip-39/ @franck44 /MIP/mip-53/ @l-monninger /MIP/mip-58/ @primata @apenzk -/MIP/mip-61/ @apenzk @musitdev /MIP/mip-60/ @franck44 @apenzk +/MIP/mip-61/ @apenzk @musitdev /MIP/mip-84/ @apenzk /MIP/mip-88/ @apenzk @Primata /MIP/mip-91/ @apenzk diff --git a/MD/md-n/README.md b/MD/md-n/README.md new file mode 100644 index 00000000..c7f6f3db --- /dev/null +++ b/MD/md-n/README.md @@ -0,0 +1,49 @@ +# MD-\: Technology publication strategy + +- **Description**: Require a technology publication strategy for both the vision and current state of the technology. +- **Authors**: Andreas Penzkofer +- **Approval**: + +## Overview + +Technology vision and current state publication strategy should be communicated to the community. We need a streamlined process for this. + +## Desiderata + +### D1: Identify the target audience + +**User journey (Author)**: The author knows which audience we are writing for. + +**Description**: Public documents should be targeted for a specific set of audience. Otherwise they miss their goals. + +**Recommendation**: Consider the following audience types: + +- Technical audience: Engineers, architects, etc. +- Business audience: Product managers, sales, etc. +- Investor audience: Shareholders, potential investors, etc. + +### D2: Create a publication product specific for a purpose + +**User journey (Author)**: The author knows the purpose of the publication. + +**Description**: Publications should be targeted for a specific purpose. Otherwise they miss their goals. + +**Recommendation**: Consider the following purposes: + +- MIP: Technical excerpt that specify the concrete ideas, technical details and requirements for a technology. +- Blog post: Informal piece that explain the author's thoughts on a technology, and that may be focused on important MIPs. +- Light paper: High-level overview of a technology, and that may include concrete ideas, technical details and requirements. They may be updated when new blog posts are published, or when the technology matures. They are in essence a **live paper**. +- White paper: A long-form piece that provides a deep dive into a technology, and that may include concrete ideas, technical details and requirements. They are the *north stars*, i.e. the technological distinguishing feature of the technology. + +### D3: Create a process to make technological vision updates accessible to the community + +**User journey (Author)**: The author understands how to transform the technological vision into a publication of some kind. +**User journey (Community)**: The community can access the technological vision in an easy and accessible way. + +**Description**: There should be a streamlined process to make technological vision updates accessible to the community. + +**Recommendation**: Consider the following process: + +- Define a clear process to transform MIPs into blog posts, light papers. + +## Changelog diff --git a/md-template.md b/md-template.md index cbff8946..ee439558 100644 --- a/md-template.md +++ b/md-template.md @@ -52,7 +52,7 @@ TODO: Remove this comment before finalizing. --> -# Changelog +## Changelog