From a265fd93ae1775b6acee21514f8cd7d3af2bebd4 Mon Sep 17 00:00:00 2001 From: David Welsch Date: Thu, 16 May 2024 15:07:15 -0700 Subject: [PATCH] Final (hopefully) changes to the techdoc analysis materials. Directory structure chnages included. Signed-off-by: David Welsch --- techdoc-assistance.md => assistance.md | 0 docs/analysis/README.md | 10 ++++++++++ docs/{ => analysis}/criteria.md | 0 docs/{ => analysis}/howto.md | 0 {resources => docs/analysis/resources}/README.md | 0 .../analysis/resources}/analysis-template.md | 0 .../analysis/resources}/implementation-template.md | 0 .../analysis/resources}/issue-template.md | 0 .../analysis/resources}/umbrella-issue-template.md | 0 9 files changed, 10 insertions(+) rename techdoc-assistance.md => assistance.md (100%) create mode 100644 docs/analysis/README.md rename docs/{ => analysis}/criteria.md (100%) rename docs/{ => analysis}/howto.md (100%) rename {resources => docs/analysis/resources}/README.md (100%) rename {resources => docs/analysis/resources}/analysis-template.md (100%) rename {resources => docs/analysis/resources}/implementation-template.md (100%) rename {resources => docs/analysis/resources}/issue-template.md (100%) rename {resources => docs/analysis/resources}/umbrella-issue-template.md (100%) diff --git a/techdoc-assistance.md b/assistance.md similarity index 100% rename from techdoc-assistance.md rename to assistance.md diff --git a/docs/analysis/README.md b/docs/analysis/README.md new file mode 100644 index 0000000..7c5e414 --- /dev/null +++ b/docs/analysis/README.md @@ -0,0 +1,10 @@ +# TechDoc Analysis + +## Contents + +This directory contains instructions and criteria for completing a documentation analysis, including a [how-to][] guide and analysis [criteria][]. + +Templates for the analyses are in the resources directory. + +[how-to]: ./howto.md +[criteria]: ./criteria.md diff --git a/docs/criteria.md b/docs/analysis/criteria.md similarity index 100% rename from docs/criteria.md rename to docs/analysis/criteria.md diff --git a/docs/howto.md b/docs/analysis/howto.md similarity index 100% rename from docs/howto.md rename to docs/analysis/howto.md diff --git a/resources/README.md b/docs/analysis/resources/README.md similarity index 100% rename from resources/README.md rename to docs/analysis/resources/README.md diff --git a/resources/analysis-template.md b/docs/analysis/resources/analysis-template.md similarity index 100% rename from resources/analysis-template.md rename to docs/analysis/resources/analysis-template.md diff --git a/resources/implementation-template.md b/docs/analysis/resources/implementation-template.md similarity index 100% rename from resources/implementation-template.md rename to docs/analysis/resources/implementation-template.md diff --git a/resources/issue-template.md b/docs/analysis/resources/issue-template.md similarity index 100% rename from resources/issue-template.md rename to docs/analysis/resources/issue-template.md diff --git a/resources/umbrella-issue-template.md b/docs/analysis/resources/umbrella-issue-template.md similarity index 100% rename from resources/umbrella-issue-template.md rename to docs/analysis/resources/umbrella-issue-template.md