Documentation Survey current progress and gaps in documentation - Backend

docs/OnTrack/Audit OnTrack related documentation.md

@@ -0,0 +1,188 @@
+**Audit OnTrack related documentation ![ref1]**
+
+**Introduction** 
+
+This document is a detailed guide for organizing and categorizing important files in the Thoth Tech OnTrack repository. It explains where each file should go based on its purpose, audience, and relevance, making it easier for both developers and users to find what they need. The guide only covers content from the OnTrack repository and clearly states whether files should stay in OnTrack or be moved to the Doubtfire Astro repository. This organized approach improves usability, supports better collaboration, and ensures the documentation is tailored to its audience. 
+
+**Repository Overview** 
+
+**Thoth Tech OnTrack Repository** 
+
+**Target Audience:** Internal development teams, new students, QA teams, and project contributors. 
+
+**Purpose:** Focuses on internal software development, system architecture, QA testing strategies, and feature documentation for OnTrack. 
+
+**Content Examples:** Software Requirement Specifications (SRS), test cases, UML designs, and UI enhancement guides. 
+
+**Doubtfire Astro Repository** 
+
+**Target Audience:** End-users, deployment teams, and external stakeholders. 
+
+**Purpose:** Provides user-facing deployment documentation, API guides, and other resources to facilitate end-user interaction with the Doubtfire Astro platform. 
+
+**Content Examples:** Deployment instructions, feature lists for end-users, and user onboarding materials. 
+
+**Purpose and Structure of Documentation** 
+
+This plan ensures that all files are appropriately categorized and relocated to their intended repositories for optimized usage. The files are divided based on their relevance to development, QA, or end-user needs. By maintaining clear organization, this document simplifies the onboarding process for new developers, enhances team collaboration, and ensures seamless knowledge transfer. 
+
+**Key Points of the Documentation Plan** 
+
+**Developer-Focused Documentation (Thoth Tech OnTrack):** 
+
+Includes files for software design, testing, and backend/frontend setup. Examples: 
+
+- Prototype SRS.md (internal requirements) ![ref1]
+- UML Design.md (system diagrams) 
+- Test-Strategy.md (QA testing plans) 
+
+**End-User-Focused Documentation (Doubtfire Astro):** Covers deployment guides and user instructions. Examples: 
+
+- Doubtfire-Deployment.md (deployment steps for users) 
+
+**Plan for Documentation Allocation** 
+
+
+
+|**Main Folder** |**Sub - Folder** |**Files** |**Description** |**Destina tion where files should go** |**Reason** |
+| :- | :- | - | - | :- | - |
+|Data Analytics Platform ||Readme.md |Overview of the Data Analytics platform |Thoth Tech Ontrack Docs |Provides high- level informati on useful for onboardi ng and general understa nding. |
+|T1\_2023 ||1\. DAP Ethical Review.md |Ethical review of data analytics project |Thoth Tech Ontrack Docs |Relevant for students onboardi ng and understa nding project ethics and standards . |
+|||2\. Data-point- research- documentation.md |Research on data points used |Thoth Tech |Helps students understa|
+
+
+
+|||||Ontrack Docs |nd specific research areas in the project. |
+| :- | :- | :- | :- | :- | :- |
+|||3\. Front-end- design.md |Documentation on front-end design |Thoth Tech Ontrack Docs |Useful for students working on or contribut ing to front-end design. |
+|||4\. Meeting minutes for DAP design plan.md |Meeting notes detailing design discussions |Thoth Tech Ontrack Docs |Useful for new contribut ors to review past decisions and design rationale. |
+|||<p>5\. QuestionnaireVI.m d </p><p>Report.docs </p>|Survey questionnaire used in research |Thoth Tech Ontrack Docs |Importan t for students or contribut ors doing similar research or enhance ments. |
+|||6\. T1 final design proposal.md |Final design proposal for T1 |Thoth Tech Ontrack Docs |Provides insight into past design plans and proposals for reference . |
+|||7\. Title.docs |Documentation template title |Thoth Tech Ontrack Docs |Useful for standardi zing documen|
+
+
+
+||||||tation structure for students. |
+| :- | :- | :- | :- | :- | :- |
+|||8\. AngularJS echart documentation.pdf |AngularJS echart usage documentation |Thoth Tech Ontrack Docs |Helps contribut ors working with specific front-end tools like AngularJ S. |
+|Deployment |Enhance d Authenti cation Research and Findings |1\. Index.md |Overview of enhanced authentication research |doubtfire- astro |Contains technical details essential for backend develope rs working on authentic ation. |
+|||2\. LDAP-and- device-research- documentation.md |Research on LDAP and device-based authentication |doubtfire- astro |Technica l research for develope rs managin g security and authentic ation. |
+||Enhance d Authenti cation |1\. Index.md |Enhanced authentication overview |doubtfire- astro |Focused on backend enhance ments, essential for API documen tation. |
+|||2\. Current-and- proposed-|Evaluation of current and |doubtfire- astro |Technica l evaluatio|
+
+
+
+|||authentication- evaluation.md |proposed authentication ||n critical for backend systems develop ment. |
+| :- | :- | - | :- | :- | :- |
+|Google Cloud |Google Cloud |1\. Index.md |Overview of Google Cloud integration |Thoth Tech Ontrack Docs |Overvie w documen tation valuable for student onboardi ng or general understa nding. |
+|||2\. Overview.md |Detailed overview of Google Cloud services |Thoth Tech- Ontrack Docs |Importan t for contribut ors needing cloud integratio n guidance . |
+|Pipeline Build |Research and Findings |1\. Index.md |Overview of research findings |Thoth Tech- Ontrack Docs |High- level overview meant for students contribut ing to pipeline develop ment. |
+|||2\. Software requirements specification document.md |Detailed software requirements specification |Doubtfire Astro |Technica l documen t necessar y for API and system develop ment. |
+
+
+
+|||3\. User stories.md |User stories related to the pipeline build |Doubtfire Astro |Essential for guiding develop ment of features tied to backend pipelines . |
+| :- | :- | - | :- | :- | :- |
+|Design Feature ||Design.md |Details design features for OnTrack |Thoth Tech- Ontrack Docs |Essential for contribut ors to understa nd design impleme ntation and integratio n. |
+||Docume ntation |1\. Index.md |Overview index for documentation files |Thoth Tech- Ontrack Docs |Provides navigatio n and overview for documen tation access. |
+|||2\. OnTrack |Main documentation file for OnTrack |Thoth Tech- Ontrack Docs |Core documen t providin g details on project setup and structure. |
+|||3\. Documentation template |Template for creating consistent documentation |Thoth Tech Ontrack Docs |Standardi zes documen tation format for easier collabora tion. |
+|||4\. Privacy policies.md |Privacy policy documentation |Thoth Tech |Ensures complian ce with |
+
+
+
+|||||Ontrack Docs |data privacy regulatio ns. |
+| :- | :- | :- | :- | :- | :- |
+|||5\. Report\_On\_Data\_t ools.md |Report on data tools used in the project |Thoth Tech Ontrack Docs |Useful for understa nding data tool integratio n and usage. |
+|||6\. Spelling-and- grammar- template.md |Template for maintaining documentation quality |Thoth Tech Ontrack Docs |Ensures consisten t quality in documen tation content. |
+|||7\. Spike-frontend- documentation- investigation.md |Investigation into front-end spikes |Thoth Tech Ontrack Docs |Provides insights into experime ntal or explorato ry work on the front end. |
+|||8\. Architecture- doc.md |Architecture documentation |doubtfire- astro |Critical for develope rs needing detailed system architect ure diagrams and explanati ons. |
+|Research and Findings ||Index.md |Overview of research findings |Thoth Tech Ontrack Docs |Serves as an index for research- related documen tation. |
+
+
+
+||Feedbac k Enhance ment |1\. Tutor feedback feature for OnTrack |Documentation on tutor feedback feature |Thoth Tech Ontrack Docs |Helps contribut ors impleme nt and understa nd feedback functiona lities. |
+| :- | :- | :- | :- | :- | :- |
+|||2\. Unit-chair- admin-stage- editor.md |Documentation for unit chair administration |Thoth Tech Ontrack Docs |Details administr ative features for better project manage ment. |
+|Frontend Migration |Deploy OnTrack using Docker |1\. Docker\_Compose\_ with\_WSL2.md |Instructions for Docker Compose setup |Thoth Tech Ontrack Docs |Essential for develope rs deployin g the project using Docker. |
+|||2\. Docker\_Setup\_Tut orial.md |Step-by-step Docker setup tutorial |Thoth Tech Ontrack Docs |Guides contribut ors on Docker setup for local develop ment. |
+|||3\. Troubleshooting\_D ocker\_Backup\_for\_ OnTrack.md |Troubleshooting Docker issues |Thoth Tech Ontrack Docs |Provides solutions for common Docker- related problems during deploym ent. |
+|||4\. Readme.md |Readme for Docker setup |Thoth Tech Ontrack Docs |Overvie w and instructio ns on Docker |
+
+
+
+||||||configura tion. |
+| :- | :- | :- | :- | :- | :- |
+|Framework ||1\. AngularJS\_note (Partial).pdf |Notes on AngularJS framework |Thoth Tech Ontrack Docs  |Provides importan t notes for develope rs using AngularJ S. |
+|||2\. Angular\_and\_Angu larJS.md |Comparison between Angular and AngularJS |Thoth Tech Ontrack Docs |Useful for understa nding framewo rk differenc es and migratio n paths. |
+|Migration ||1\. Create\_Branch\_and \_Initial\_Migration. md |Guide to branch creation and migration |Thoth Tech Ontrack Docs |Helps in setting up new branches and handling initial migratio ns effectivel y. |
+|||2\. Regular\_Migration \_Step.md |Steps for regular migrations |Thoth Tech Ontrack Docs |Provides structure d steps for migratio n tasks, ensuring consisten cy. |
+|||3\. Readme.md |Readme for migration documentation |Thoth Tech Ontrack Docs |Overvie w for understa nding the migratio n process. |
+|Testing ||1\. Unit\_test.md |Unit testing documentation |doubtfire- astro |Crucial for backend |
+
+
+
+||||||develope rs working on automate d testing. |
+| :- | :- | :- | :- | :- | :- |
+|Group Task Submission ||1\. Group\_Task\_Subm ission\_doc.md |Documentation for group task submissions |Thoth Tech Ontrack Docs |Useful for referenci ng past group submissi ons and collabora tive efforts. |
+|||2\. Group\_Task\_Subm ission\_uml\_design. md |UML design for group submission |Thoth Tech Ontrack Docs |Provides design diagrams for group project submissi ons. |
+|Incorporate Content |OnTrack |1\. Design\_Document. md |Main design document |doubtfire- astro |Essential for backend develope rs focusing on system design. |
+|||2\. Gather\_Requireme nts.md |Requirements gathering document |doubtfire- astro |Guides the collectio n of system and user requirem ents. |
+|||3\. Incorporate\_doc.m d |Documentation for incorporating new features |Thoth Tech Ontrack Docs |Explains how to integrate new content and features into the project. |
+
+
+
+|||4\. UML\_Diagram.md |UML diagrams for system design |doubtfire- astro |Useful for visualizi ng system architect ure and design structure. |
+| :- | :- | :- | :- | :- | :- |
+|Jupyter Notebook |Meeting Minutes |1\. Docker- Containers- SRS.md |Data about docker containers |Thoth Tech Ontrack Docs |For onboardi ng students on Docker container setup requirem ents. |
+|||2\. Docker- Documentation- Research-T1- 2022.md ||Thoth Tech Ontrack Docs |Detailed research documen tation for internal use by develope rs. |
+|||3\. Jupyter- Notebook-Epic-T1- 2022.md ||Thoth Tech Ontrack Docs |Describe s develop ment features of the Jupyter Noteboo k Epic. |
+|||4\. Prototype SRS.md ||Thoth Tech Ontrack Docs |Contains software requirem ents for internal develop ment purposes. |
+|Local Setup ||How to Run OnTrack with Ubuntu.md ||Thoth Tech Ontrack Docs |Provides essential setup instructio ns for |
+
+
+
+||||||develope rs. |
+| :- | :- | :- | :- | :- | :- |
+|Multiple Organization s ||1\. Design Documentation.md ||Thoth Tech Ontrack Docs |Provides design framewo rk for managin g multiple organizat ions. |
+|||2\. Gather requirements for multiple orgs.md ||Thoth Tech Ontrack Docs |Ensures develope rs understa nd specific multi-org setup requirem ents. |
+|||3\. Test Scenario Requirements.md ||Thoth Tech Ontrack Docs |Internal QA testing scenarios for multi- organizat ion functiona lity. |
+|||4\. UML Design.md ||Thoth Tech Ontrack Docs |Visual guide for internal system architect ure. |
+|Numbas ||1\. NumbasFeasability Check.md ||Thoth Tech Ontrack Docs |Evaluate s the feasibilit y of Numbas for internal develope rs. |
+|||2\. NumbasProjectGui deline.md ||Thoth Tech Ontrack Docs |Guidelin es for integratin g |
+
+
+
+||||||Numbas for internal use. |
+| :- | :- | :- | :- | :- | :- |
+|||3\. ProjectSignOffNu mbas.md ||Thoth Tech Ontrack Docs |Marks project approval for internal Numbas integratio n. |
+|||4\. SpikeOutcome- Scorm2004.md ||Thoth Tech Ontrack Docs |Docume nts SCORM 2004 experime ntal results for internal research. |
+|QA |Meeting Minutes |1\. Doubtfire- Deployment.md ||Doubtfire -Astro |End-user deploym ent documen tation for Doubtfir e. |
+|||2\. FeatureList.md ||Thoth Tech Ontrack Docs |List of features for QA purposes. |
+|||3\. Test-Case- List.md ||Thoth Tech Ontrack Docs |Internal list of QA test cases. |
+|||4\. Test-Case- Template.md ||Thoth Tech Ontrack Docs |Template for test case documen tation for internal QA use. |
+|||5\. Test-Strategy.md ||Thoth Tech Ontrack Docs |Provides QA strategy for internal develop|
+
+
+
+||||||ment teams. |
+| :- | :- | :- | :- | :- | :- |
+|||6\. UI\_automation\_get ting\_started\_guide. md ||Thoth Tech Ontrack Docs |Internal guide for initiating UI automati on. |
+|Security Analysis ||Index.md ||Thoth Tech Ontrack Docs |Organize s internal security analysis files for develope rs. |
+|Staff Grant Extension |Docume ntation |1\. DESIGN.md ||Thoth Tech Ontrack Docs |Design documen t specific to staff grant extension s for internal use. |
+|||2\. REQUIREMENTS .md ||Thoth Tech Ontrack Docs |Outlines internal requirem ents for staff grant extension . |
+|Task Submission |Backend |Readme.md ||Thoth Tech Ontrack Docs |Backend setup for internal develope rs. |
+||Frontend  |Readme.md ||Thoth Tech Ontrack Docs |Frontend setup for internal develope rs. |
+|||1\. Project-On- Boarding.md ||Thoth Tech Ontrack Docs |Ensures new develope rs can onboard successfu lly. |
+
+
+
+|||2\. ProjectScope- SignOff- Document.md ||Thoth Tech Ontrack Docs |Defines the scope of the internal project. |
+| :- | :- | :- | :- | :- | :- |
+|Tutor Times |Docume ntation |1\. DESIGN- BACK-END.md ||Thoth Tech Ontrack Docs |Backend design details for tutors and develope rs. |
+|||2\. DESIGN- FRONT-END.md ||Thoth Tech Ontrack Docs |Frontend design details for tutors and develope rs. |
+|UI Enhancement |Compon ent Review |1\. comments- modal.md ||Thoth Tech Ontrack Docs |Docume nts internal UI enhance ments for develop ment reference . |
+|||2\. local\_storage.md ||Thoth Tech Ontrack Docs |Explains how local storage is utilized internally . |
+|Voice Verification ||1\. Architecture- Document.md ||Thoth Tech Ontrack Docs |Provides system architect ure details for voice verificati on. |
+
+[ref1]: Aspose.Words.94e66dc5-d11a-4d7d-aa66-ab756b7cd8c8.001.png