Started adding GLM-Associate-Documentation directory and files
authorChuck Scott <cscott@gaslightmedia.com>
Fri, 25 Oct 2019 15:08:26 +0000 (11:08 -0400)
committerChuck Scott <cscott@gaslightmedia.com>
Fri, 25 Oct 2019 15:08:26 +0000 (11:08 -0400)
GLM-Associate-Documentation/Assets/000-ReadMe.txt [new file with mode: 0644]
GLM-Associate-Documentation/Developer/Detailed-Features.txt [new file with mode: 0644]
GLM-Associate-Documentation/Developer/Important-Internals.txt [new file with mode: 0644]
GLM-Associate-Documentation/User/Feature-List [new file with mode: 0644]
GLM-Associate-Documentation/User/User-Documentation [new file with mode: 0644]

diff --git a/GLM-Associate-Documentation/Assets/000-ReadMe.txt b/GLM-Associate-Documentation/Assets/000-ReadMe.txt
new file mode 100644 (file)
index 0000000..4b16605
--- /dev/null
@@ -0,0 +1,16 @@
+GLM Associate Documentation Assets
+==================================
+
+This directory is for storing image and other non-text files that are
+referenced in the documenation. These should be kept logically organized
+in appropriate sub-directories.
+
+It might be good to list all of these files here with a short explanation
+of them and where they're used to make it easy to find them if the need to
+be referenced from another place in the documentation. Possibly using the
+list format below.
+
+Filename                Description
+    Where used
+----------------------------------------------------------------------------
+file1.jpg               Sample view of main admin dashboard
diff --git a/GLM-Associate-Documentation/Developer/Detailed-Features.txt b/GLM-Associate-Documentation/Developer/Detailed-Features.txt
new file mode 100644 (file)
index 0000000..e69de29
diff --git a/GLM-Associate-Documentation/Developer/Important-Internals.txt b/GLM-Associate-Documentation/Developer/Important-Internals.txt
new file mode 100644 (file)
index 0000000..e69de29
diff --git a/GLM-Associate-Documentation/User/Feature-List b/GLM-Associate-Documentation/User/Feature-List
new file mode 100644 (file)
index 0000000..d02a374
--- /dev/null
@@ -0,0 +1,13 @@
+GLM Associate User Feature List
+===============================
+
+This is a feature list for clients and users that can be used in
+documentation for users and to create sales information in the
+glmassociate.gaslightmedia.com Website and printed brochures.
+
+This is not a detailed feature list, it's intended to be a simple
+list of all major features and important minor features to help
+a prospective client/user understand the overall capabilities
+of the GLM Associate.
+
+This should be in an outline format with features grouped logically.
diff --git a/GLM-Associate-Documentation/User/User-Documentation b/GLM-Associate-Documentation/User/User-Documentation
new file mode 100644 (file)
index 0000000..e32d31e
--- /dev/null
@@ -0,0 +1,12 @@
+GLM Associate User Documentation
+================================
+
+This should be a comprehensive outline of user documentation along with
+descriptive text that will be used in creating and updating the user
+documentation and also for creating and updating help information
+for the user interfaces (admin, and potentially front-end).
+
+Where a file or image needs to be referenced it should be listed where
+it would be used in this file and placed in the "assets" subdirectory.
+
+We'll need to work out a format that works for this file
\ No newline at end of file