hackforla / hackforla/tdm-calculator

Content: Admin Guide

Open
#2,371 5 comments 0 reactions 0 assignees View on GitHub
deck: staging level: medium p-feature: Admin Guide Participant type: Admin priority: SHOULD HAVE role: ux content writing size: 3pt
Dominant language
JavaScript
Stars
68
Forks
47
Avg merge
3d 9h
Merged PRs (30d)
25

Description

### Overview
We need to write content for the Admin Guide Page so that admin users will know how to manage the site after we hand it off to LADOT and LACP.

### Details
The design portion of the Admin Guide—that is, anything that has to do with the aesthetics and functionality of the page—is being addressed in #1726.

This issue, #2371, addresses all the content that will be entered in the Admin Guide page in FAQ format. Please develop a list of FAQs that explain concepts and functionality on the site that is specific to admin users.

Examples of what FAQ content should be included on the Admin Guide page include:
- Instructions on how to change people’s permissions as a security admin.
- An explanation of how the Archived Users and Archived Projects pages work.
- What to do in the case where a user is an employee of a company and the employee leaves the company, but the company wants access to that employee's snapshots. Would require a workflow in which snapshots are shared.

### Action Items
- [ ] Assign yourself to this issue.
- [ ] Move the issue from Prioritized Backlog to In Progress.
- [ ] Go to the folder (resource 1.01), and Create a Google Document called
```
Admin Guide How to's for administering the FAQ- Issue 2371
```
- [ ] Add a link to the document into the resources below (resource 1.01.01)
- [ ] Use the document to draft questions
- Once this issue is ready to be reviewed:
- [ ] Add a comment tagging the team design lead that explains the wording
- [ ] Move it to the Visual Review column.
- [ ] Add the "ready for Content lead" label and add to the Questions column
- [ ] Once you have received feedback from the team lead, implement feedback as necessary.
- [ ] Review with product by adding a `ready for product` label and putting in the questions column
- [ ] Update if needed based on feedback
- once signed off internally
- [ ] Use [presentation structure](https://github.com/hackforla/tdm-calculator/wiki/Design:-Presentations) to review proposed designs with the product, development, and research teams. Implement feedback as necessary.
- [ ] Receive design approval from stakeholders. Implement feedback as necessary.
- [ ] Reassign any previous assignees to this issue.
- [ ] Close this issue.

### Resources
- 1.01 [TDM Google Drive > UI/UX >Content (written content for the site) > Admin Guide](https://drive.google.com/drive/folders/1tyzOakgMoDcMtk7vjDlJ9twA3UQwCMdd)
- 1.01.01 Draft: [Admin Guide How to's for administering the FAQ- Issue 2371]

#### GitHub
- Design of Admin guide page: #1726

#### Figma
- [1726 Figma](https://www.figma.com/design/nD9QK56Mzq7xNSaSUoeGx0/TDM-Calculator?node-id=4919-17247)

#### Dev Site
- The Admin Guide has not yet been implemented on the Dev site.

#### Staging and Release decks
- [Staging Deck](https://docs.google.com/presentation/d/1crZ3IxqA4hAu3qzD7ns93Ieuqjwh6wyEtuX_46cP-fg/)
- [Staging Deck, slide 2371](https://docs.google.com/presentation/d/1crZ3IxqA4hAu3qzD7ns93Ieuqjwh6wyEtuX_46cP-fg/edit#slide=id.g34bf049f908_1_22)
- Release Deck
- [2025-MM-DD Release deck, slide 2371]

Contributor guide

Open the contributing guide

Research direction

Start with the Admin Guide resources in the TDM Google Drive and review issue #1726 for the related page design. Draft FAQ questions covering admin permissions, archived users and projects, and snapshot access when an employee leaves. Done means the FAQ document is linked, reviewed through the listed design and product steps, updated from feedback, and signed off internally.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.