Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation to reflect changes in the copy delivery process #2218

Closed
1 task
indexing opened this issue Jul 11, 2024 · 6 comments · Fixed by #2466
Closed
1 task

Update documentation to reflect changes in the copy delivery process #2218

indexing opened this issue Jul 11, 2024 · 6 comments · Fixed by #2466
Assignees
Labels
design UX/UI research and tasks: Figma documentation [auto] Improvements or additions to documentation

Comments

@indexing
Copy link
Member

Revise this section of our documentation to include support for Ditto and any other changes in the process that result from adopting Ditto.

https://docs.calitp.org/benefits/product-and-design/copy-delivery/

Acceptance Criteria

  • Documentation accurately reflects current process.
@indexing indexing added the deliverable Work that ends with a non-code deliverable (e.g. Google doc) label Jul 11, 2024
@indexing indexing moved this from Todo to Stretch in Digital Services Jul 11, 2024
@thekaveman thekaveman added documentation [auto] Improvements or additions to documentation and removed deliverable Work that ends with a non-code deliverable (e.g. Google doc) labels Jul 12, 2024
@indexing
Copy link
Member Author

@srhhnry You mentioned yesterday that you were writing down the "how" behind our Ditto implementation. Once we've ironed out the kinks in our approach, will you update this documentation?

@thekaveman thekaveman added the product Issue captures work for the product team label Jul 23, 2024
@indexing indexing assigned indexing and srhhnry and unassigned indexing Aug 7, 2024
@indexing indexing added design UX/UI research and tasks: Figma and removed product Issue captures work for the product team labels Aug 7, 2024
@srhhnry
Copy link

srhhnry commented Aug 8, 2024

Here's the current doc that outlines how Figma/Ditto/Crowdin work together: https://docs.google.com/document/d/1AZW63qNk25_vEkuzoIqZJt-T5QcLBLc2TEEwtGznz_k/edit?usp=sharing

Let me know if there are more questions or things that are unclear. To note, I've also tested the process for translating variants that's described here and it looks like it works pretty well due to all of the text being componentized.

@srhhnry
Copy link

srhhnry commented Aug 23, 2024

@indexing or @thekaveman I think I need permission to edit the docs.cal-itp copy process page. I don't see a setting for it anywhere so I think I need a permission change?

@thekaveman
Copy link
Member

@srhhnry you are on a GitHub team that has write access to this repository, so you should be able to edit the file and submit a Pull Request with your edits. This can be done directly within the GitHub website interface:

  1. Navigate to the repository homepage: https://github.com/cal-itp/benefits
  2. Navigate to the specific documentation markdown file inside the docs folder: docs/product-and-design/copy-delivery.md
  3. Click the edit (pencil) icon on the file to enter edit mode
    2024-08-26_14-59
  4. Make your changes in the markdown editor (previewing along the way if you like), and "Commit" when finished
    image

@thekaveman thekaveman linked a pull request Sep 23, 2024 that will close this issue
@thekaveman thekaveman moved this from Stretch to In review in Digital Services Sep 23, 2024
@srhhnry
Copy link

srhhnry commented Oct 10, 2024

Documentation is complete in this doc: https://docs.google.com/document/d/1N-sVEEfo2ghklVDlbgvKWDr3fMjSlE4j8rC0_55OYJ0/edit?usp=sharing

@machikoyasuda volunteered to update the github docs site (thank you thank you!) with the completed copy.

@srhhnry
Copy link

srhhnry commented Oct 11, 2024

Update: @machikoyasuda (and other interested parties): I added this section on Timeline:

Timeline
Design follows the sprint schedule set by Product and Engineering, however there is no standard number of sprints or time within a sprint dedicated to the copy process. Rather, the process timeline is determined by effort required.

Generally, Design will conduct research in an effort to determine parameters for the copy and to shape a first draft. Those parameters are then approved and/or finalized by Product. After that design then does a UX writing pass and further shapes the copy. Copy is reviewed by Product and then reviewed by Engineering during handoff.

Engineering requests that the copy is finished before the design review and before the next sprint starts (presumably the sprint the copy would be implemented in). Translating the copy takes about a week so it’s important to plan accordingly.

@thekaveman thekaveman moved this from In review to In progress in Digital Services Oct 15, 2024
@angela-tran angela-tran moved this from In progress to In review in Digital Services Oct 18, 2024
@angela-tran angela-tran self-assigned this Oct 18, 2024
@github-project-automation github-project-automation bot moved this from In review to Done in Digital Services Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design UX/UI research and tasks: Figma documentation [auto] Improvements or additions to documentation
Projects
Status: Done
5 participants