Weekly Update, Meeting Recap and Agenda
PROJECT OVERVIEW
Project Objective Discover opportunities to ensure Arti's documentation is up to standard and write documentation for Arti
ADDITIONAL EXPECTATIONS(Click to expand)
Per Monday, August 14th: 1- Please use common language in documentation for all personas
2- The Arti documentation project will be a template or guidance for future documentatio structure.
3- Example of Rust Documentation from the Arti team https://serde.rs/ , https://docs.rs/tokio/latest/tokio/
4- Example of power user documentation and Gabi used the documentation to get started. (always room for improvement!) https://gitlab.torproject.org/legacy/trac/-/wikis/doc/TorifyHOWTO
Timeline
Next Step timeline: TBD
Both content audit, UX research, and the final report will be delivered by September 6th. -- Completed.
Click for Phase I Deliverables
KICKOFF PHASE II AGENDA AND MINUTES
Date September 14th, 2023 Meeting Recording here
(Recording access is restricted; please let Gaba knows should you need access)
Final report presentation and findings
The Highlighted Issue and Actionable Next Steps -- click to expand
I. Documentation is Scattered
Issue: Documentation is scattered. Navigating and grabbing information has proven difficult.
Solution: Implement a sitemap on a single platform with unified docs. (Dependencies on the final sitemap)
Impact: Users can grab information easier and faster.
II. Existing Docs Can Improve User Friendliness
Issue: Based on UX research, Most users are learning Arti and Rust. Therefore, Advance Rust for documentation is not quite as helpful.
Solution: Revise Getting Started and tutorial with a beginner-level Rust user's mindset, more verbose, and easy copy-paste examples.
Impact: A more accessible and lower barrier in Arti documentation.
III. Lack of Context in Documentation
Issue: Some users need more time to understand Arti instructions due to a lack of context in how Arti works.
Solution: Add conceptual guides that include Arti architecture.
Impact: Users can achieve understanding and move on to the next step faster.
IV. Outdated docs
Issue: Some of the documentation is outdated
Solution: Keeping the documentation up-to-date. DocumentWrite team will rewrite some of the documentation.
Impact: Less confusion among users.
V. Lack of common use case
Issue: Related to outdated docs and context. Users can't relate to some of the existing use cases.
Solution: On top of keeping the documentation up to date and always providing context, Arti would need a common example in Documentation, such as embedding Arti or configuring bridges for censorship documentation.
Impact: The user can relate to the use case better.
A more comprehensive explanation can be read in [final audit and UX research report.] (https://docs.google.com/document/d/1QmeejQaBnk3y4F8zyB2w9sx2ZzRZxSvTPLmCwkz7QbM/edit#heading=h.2jtu73z9bwl3)
Summary of agreed upon next step:
-
Arti and Documentwrite to collaborate on the final sitemap
-
We agree to proceed with Docsaurus as the new documentation platform. Once step one is done, DocumentWrite will build a base and migrate the documentation. **we've established that Docsaurus can run without javascript
-
While migrating, our team will revise outdated documentation, write getting started, and tutorials.
-
The Arti design team would be responsible for the front-end part of the documentation. @gaba, would it be possible for the Arti team to help with domain management for the migration?
-
DocumentWrite to help with any future releases.
Weekly Update Phase II
11/6 - 11/9
- Submitted eight merge requests currently under review by Arti
10/30 - 11/3
Accomplishment
-
Alignment on review process
-
The Arti team approved the latest merge requests.
Next Step
- Continue writing documentation
10/23 - 10/27
Accomplishment
-
Schedule a meeting to review 19 documentation to review
Next step
-
Review the documentation
-
Continue working on Arti documentation.
10/16 - 10/19
Accomplishment
@pkafei will discuss with @gaba on review cadence.
- Discovery meeting with Ian to help write new documentation.
Next step:
-
Receive additional resources to write Creating configuration options
-
Continue writing documentation.
-
Settle on review process for the submitted 19 documentation
10/02 - 10/13
Accomplishment
- Merged the following here
frequently asked questions (faqs)
safer build options
using bridges with Arti
troubleshooting: fixing some common problems
protocol support and compatibility for arti
compiling for android
compiling for ios
examples (a page with list of example projects from the repo)
overview (how to contribute)
code of conduct
support policy
overview (project status)
changelog
Next step:
-
Continue with documentation writing (Gitlab ticket to be added)
-
Meet with Ian Jackson to get some clarity on net new documentation/article
9/25 - 9/28
Accomplishment
- Confirm repositories for docsaurus
Next Step
- Write new documentation "about Arti"
9/11 - 9/22
Accomplishment
-
Alignment on Arti documentation next step by September 14th
-
Receive the first sitemap feedback
-
Analyze sitemap feedback and adjustments to impact the documentation writing scope.
-
Build Docsaurus base
Next Step
-
Gain access to the appropriate Arti repo for docsaurus
-
Provide second draft of sitemap
-
Submit all documentation writing ticket to Gitlab
**Weekly Update Phase I **
8/4 - 9/8
**Accomplishment **
- DocumentWrite submitted sitemap, content audit raw data, User interview recording, final audit and UX research report here.
Next Step
Priority of the week
- Arti and the DocumentWrite team to meet for the final presentation. Feel free to vote the time that works best for you here.
8/28 - 9/1
**Accomplishment **
-
Completing the interview and card sort. The last user was Dan, who was interviewed on August 29
-
Content audit raw data has passed the DocumentWrite QA team check and is under final polish
-
Arti Sitemap's recommendation is submitted to DocumentWrite's internal QA process
Next Step
**Priority of the week **
-
DocumentWrite to finish content audit and UX research final report analysis
-
DocumentWrite to package content audit raw data, content audit and UX research final report
-
Arti and the DocumentWrite team to meet for the final presentation. Feel free to use this calendar to book a time. Should you need to schedule multiple people, feel free to schedule still and notify Harleta, she'd be happy to add the other guests to the invite.
8/22 - 8/25
**Accomplishment **
-
Finalize interview questions
-
Content audit: 60% went through an internal QA check
-
Conducting card sorting session
-
Conducting two out of three user interviews
Next Step
Priority of the week
-
Reschedule Dan. Sadly Dan was a no-show during the interview @charlie-doc-writer is working with him to reschedule
-
Update card sort invite. -- completed.
-
Continue with content audit
8/14 - 8/18
Accomplishment
1 - Schedule 3 users for an interview
------ Dan August 22nd
------ Pier August 24th
------ Ian August 24th
2 - Schedule 1 user for card sorting
------ Era, Ma, and Micah August 24th
3 - Arti provided a list of mission-critical tasks
4 - Content audit early findings here
Next Step
**Priority of the week **
(Sorted by highest priority)
1 - Charles to deliver first draft of interview questions based on the shared mission-critical task.
8/7 - 8/11
**Accomplishment **
-
Charles connected with the engineer and get the code up and running
-
Understood Arti inventory to proceed with other analysis in the content audit.
-
Identifying crucial use case with Arti team needs to happen before Card sorting and user interview. All card sorting date and user interviews are moved to the week of August 21st
-
Gaba found users to interview .
-
Harleta provided new calendar link for user interview, doodle for card sorting, and doodle for use case meeting
**Priority of the week **
(Sorted by highest priority)
-
Gaba to encourage Arti team to vote on use case meeting time. It looked like both Gaba and Ian can't meet at the same time. Would this be a problem?
-
Card sorting preparation: Gaba to users for card sort using card sorting link provided here.
-
Charles and Gaba to start encouraging users to schedule within the week of August 22nd range due to timeline changes
-
Charles to Complete 40% of the content audit first draft for internal QA.
8/1 - 8/4 2023
-
Gaba to connect Charles with the engineer who can help him onboard per August 3rd
-
Charles is working on the scheduled time with engineer on August 4th
Meeting Notes
Date: Monday, August 14th, 2023
Talking Points
Date: Wednesday, August 2nd, 2023
Talking Points
Team Introduction
a. Portia - Founder of DocumentWrite
b. Charles - Technical writer
c. Harleta - Project manager
d. Gaba - Project owner and Arti project manager
Project Objective Discover opportunities to ensure Arti's documentation is up to standard and write documentation for Arti
Project Timeline Both content audit, Ux research, and the final report will be delivered by September 6th.
All updates will be done asynchronously, and Gitlab is our project management system.
All link resources are shared here.
Next Step
1. Gaba to complete user interview preparation after receiving the new calendar
2. Gaba to connect Charles with the engineer who can help him onboard