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

[Request]: Fix typos on QASP page of de-risking guide #448

Closed
2 of 9 tasks
beechnut opened this issue Jan 9, 2024 · 7 comments
Closed
2 of 9 tasks

[Request]: Fix typos on QASP page of de-risking guide #448

beechnut opened this issue Jan 9, 2024 · 7 comments
Assignees
Labels
Guides Initiative 2 Tracks work for "Improving the Maintainability of the 18F Guides and Methods"

Comments

@beechnut
Copy link
Contributor

beechnut commented Jan 9, 2024

A description of the work

The QASP page has a table with a number of typos in many cells.

A couple examples:

  • "...and a clean code baseVersion-controlled..." should probably be two lines
  • "A system diagram is provided" cuts off, I suspect this should finish with something like "each release."

There might be more typos, but these were the ones I found.

Point of contact on this issue

No response

Reproduction steps (if necessary)

No response

Skills Needed

  • Any Human
  • Design
  • Content
  • Engineering
  • Acquisition
  • Product
  • Other

Does this need to happen in the next 2 weeks?

  • Yes
  • No

How much time do you anticipate this work taking?

3 hours

Acceptance Criteria

Typos are fixed, line breaks are placed appropriately.

@beechnut beechnut added Guides Initiative 2 Tracks work for "Improving the Maintainability of the 18F Guides and Methods" labels Jan 9, 2024
@juliaklindpaintner
Copy link
Contributor

Note: The first of the two typos is addressed in #455

@amandarkennedy
Copy link
Contributor

@juliaklindpaintner can you clarify your above comment? I am still seeing both issues in the Sample QASP.

Note: The first of the two typos is addressed in #455

@juliaklindpaintner
Copy link
Contributor

Sorry, @amandarkennedy. I got a little mixed up. I ended up deleting #455 in favor of this ticket. I have already made an update, but the PR isn't merged yet, because I wanted to wait and add the other fix so we could just do one PR together. You're right that both issues are still there on the live site.

Re: the second issue, I took a look at the print version of the guides, and it doesn't appear that any other copy is missing. Perhaps we just add a period to the end of these so that it doesn't seem cut off?

@amandarkennedy
Copy link
Contributor

@juliaklindpaintner Gotcha, no worries!

Re: the second issue, I know what you mean. I have noticed at 18F, though, that our typical "style" is to not include a period at the end of a sentence in a table or within a bullet point. Would you say that is the case?

@juliaklindpaintner
Copy link
Contributor

juliaklindpaintner commented Jan 24, 2024

@amandarkennedy Here's the guidance around punctuation in the Content Guide. In this instance, it's in sentence form, so I think a period makes sense (also because the sentences before it have periods). We can also talk about whether we should include line breaks to make it more like bullet points. I think we can make a call on what seems clearest.

@amandarkennedy
Copy link
Contributor

@juliaklindpaintner oooh, thank you. perfect! looking forward to talking more.

@juliaklindpaintner
Copy link
Contributor

Done and updated!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Guides Initiative 2 Tracks work for "Improving the Maintainability of the 18F Guides and Methods"
Projects
None yet
Development

No branches or pull requests

3 participants