As discussed in the team meeting on the 3rd of April, the team collectively decided to analyse

the repos prior to starting any documentation.  

What: 
The team will collectively analyze all product repositories and report on the current state.  
Why? 
By doing this, we can understand how the documentation is looking for all of our
repositories. As some of the GitHub repos are complete (where they don’t need to be
changed) and others that require significant urgent attention. 
How: 
Head onto the Thoth Tech Github. Select the repo that you would like to analyze (you can
opt to analyze more than one). Please go through every single folder and file. Interpret them
(in detail) and leave notes for what you have seen. Look out for things such as broken
hyperlinks or incomplete articles. Try be as precise as you can whilst remembering to also be
succinct.  
What do I do now? 
For each repo, please go through every single repository. Below is a table of what repos are
available. Once you have selected your repo, please fill in you name in the “name” section.  
Repo  Person Analyzing 
Doubtfire-Api  Shivam 
arcade-machine   
handbook  Everyone 
splashkit-translator   
doubtfire-web   
doubtfire-deploy   
Doubtfire.io*  Shivam 
splashkit-core   
skm   
doubtfire-api   
doubtfire-overseer  Manisha 
programming-arcana  Kosta 
splashkit.io   
doubtfire-speaker-verification  Manisha 
*Added 10/4/22 by Talia 
Also, please do not forget to log your hours in worklog. Every minute adds up and each
contribution is valuable. 
How to report: 
To ensure we capture all of the data accurately, just go through each repo and report your
findings. If pages are blank, report that and we will address it as a team later down the
track.  
Doubtfire-Api Analysis: 
 Readme file is up to date with no errors. There is also a great amount of information
on the repo and the API functionalities.  
 Contributing.md is a great source for individuals looking to contribute to the
Doubtfire API. 
 Changelog.md is up to date and all of the functionalities are current and recent. 
 Docker connection files are within the repository. 
 Quality assurance for OnTrack can be found under pull_request_template.md 
 The doubtfire api functionality is in charge of delivering the doubtfire services to the
users. It is the serving block of the OnTrack platform and there is a strong requirement for
this documentation to be up to date as this is where most of the internal work and backend
teams. Technical documentation is up to date but there needs to be work around the sub
folders.  

This is example of the reports

Doubtfire.io 
Analysis  table EXAMPLE/TEMPLATE     
Repo/Filename  Complete?  Correct?  Up-to Format? Description Type of doc? 
date?  Messy,
heading
etc 
doubtfire-api     
file1.md  Yes  No  No  …  …  User guide 
file2.md  No  Yes  No  …  …  Requirements 
file3.md            How to guide 
file4.md            Design 
doubtfire-web 
…             
  This github repository oversees the current Doubtfire website (doubtfire.io). The
website is mainly static with no primary features, however, the content on here is valuable.
There is markdown formatted user guides for all types of users within OnTrack. We have
copied this GitHub repo for the internal team who are designing a static site generator and
they will use this repo as a reference and guide.Page Break 
 

Example of the template

This was all example on the top. Task needs to be done starts after this

Task 1

Create a report template like a example given. And do 2 report on doubtfire deploy and doubtfire
web. I need one blank template and 2 report template of this 2.

Task2

Create a word doc for each and and mark as it is like prblm state this then proposed solution this and
go on for each task.

1
2

3
4

5( use this template and produce solution for all task 2 reports)

Task 1 is 100 +100 =200 words

Task 2 100*8= 800 words