Review Onboarding Documentation

kchotani commented 5 months ago

Overview

This issue has been created to review onboarding documentation and to ensure that it is clear and provides all the relevant information for new members joining the Civic Tech Jobs project.

Action Items

[x] Review Read Me Page on Github
[x] Review Mk Docs page for CTJ
[ ] Review Kanban Board Onboarding Section
[ ] Document Open questions and Suggestions in the Issue.

Questions/Comments/Suggestions

Project Context Section should have the One sheet above the paragraph describing the people working on the project. Preferably a line that says to review the one sheet for an outline on project details and then more about the people.
The One sheet document itself lists what is live and what is pending and on the 6 month roadmap, however it doesn't give an overview of the features that are being built for MVP. I understand the one page is meant to be more concise, but this information could be captured as scope on one pager and in more detail on the mk docs wiki (perhaps?) so new members understand the functionality being built. (Adding a feature based Roadmap?)
Question for clarification - which project is doing the matching of the volunteer to the open listing? CTJ or the CMS? My understanding is that this is part of CTJ project. It would be helpful to have a paragraph explaining the two teams, what their scope is and how they are working together for MVP. So new members are clear on the scope, and dependency on other teams? ( Combined Roadmap or Feature list?)
Under Technology Used | Documentation Section - MKdocs and the doc site are listed together. To be consistent with how other technologies have been listed, perhaps only listing mkdocs navigating to the doc site.
On the MK Doc site - History page link doesn't lead to a history page.

Resources

Access the Data Wiki page

kcoronel commented 5 months ago

@kchotani here is an issue I created for the new Dev lead - if it works out well, we can have this be a template and as soon as new project members are added to the repo this issue is created for them. https://github.com/hackforla/CivicTechJobs/issues/491

Also added Access the Data Wiki page as an example of another Hack for LA's project under resources above

kcoronel commented 5 months ago

@kchotani saw this document in the CTJ drive - super helpful doc for incoming PMs - https://docs.google.com/document/d/18bx-7Fl2advVLTrBEX4F2CEmS6cfz_Fv5VaT1HTAENE/edit we should see where we can add it in our onboarding documentation

hackforla / CivicTechJobs