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.

Sign up for GitHub

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

Jump to bottom

Review the technical writing handbook #1105

Open
justinegeffen opened this issue Oct 7, 2022 · 1 comment
Open

Review the technical writing handbook #1105

justinegeffen opened this issue Oct 7, 2022 · 1 comment
Labels
help wanted Extra attention is needed

Comments

@justinegeffen
Copy link
Contributor

The technical writing handbook is our go-to for everything from our style guide to our processes. However, as it's grown it's become unwieldy in terms of structure.

What we need is fresh eyes on the handbook, which is here and feedback about:

  • How the content is organized
  • Whether the content is readable and accessible to multiple audiences
  • What's missing from the content
  • What's extraneous in the content
  • Whether there's duplicate content

Any and all feedback is welcome and you're encouraged to make whatever changes you see fit. Once the PR is open, you'll have full access to the docs team for support and assistance.

Questions? You can find us at the DWG channel on our community server.
@justinegeffen justinegeffen added help wanted Extra attention is needed Hacktoberfest labels Oct 7, 2022
@Santhusha-bit
Copy link

Can I work on this issue?

@ghost ghost mentioned this issue Mar 31, 2023
Merged
justinegeffen pushed a commit that referenced this issue Apr 5, 2023
[GH-1105] - WIP - Documentation style guide revision (#1196)
2ca50a3 
* Add ".DS_Store" to gitignore

* Added section on merge conflicts

* Added files to .gitignore

* Created Using RST & MD pages

* Edited Doc style guide, added .DS_Store to gitignore

* Re-ordered sections in style guide

* Edited style guide, added new pages to SUMMARY.md
justinegeffen added a commit that referenced this issue Apr 5, 2023
@justinegeffen
Revert "[GH-1105] - WIP - Documentation style guide revision (#1196)"
73d01fd 
This reverts commit 2ca50a3.
justinegeffen added a commit that referenced this issue Apr 5, 2023
@justinegeffen
Revert "[GH-1105] - WIP - Documentation style guide revision (#1196)" (…
928a86d 
…#1199)

This reverts commit 2ca50a3.
@cwarnermm cwarnermm changed the title Hacktoberfest: Review the technical writing handbook Review the technical writing handbook Aug 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@justinegeffen @simcard0000 @Santhusha-bit