Commit de3824b7 authored by Taurie Davis's avatar Taurie Davis Committed by Valerie Karnes
Browse files

Move Technical Writing handbook from UX to Marketing

parent f9459270
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -666,7 +666,7 @@ content/handbook/people-group/time-off-and-absence/ @amccrank @dparsonage @vanes
/content/handbook/teamops/ @spatching

^[Technical-Writing]
/content/handbook/product/ux/technical-writing/ @rjlandry @sarahwatt @jonahsterling
/content/handbook/marketing/technical-writing/ @rjlandry @sarahwatt

^[total-rewards]
/content/handbook/total-rewards/ @rallen3 @Rkole @amccrank
+1 −1
Original line number Diff line number Diff line
@@ -350,7 +350,7 @@ is "broken" and pipelines are failing for everyone, the root issue is most likel
Consider this [example error](https://gitlab.com/gitlab-com/content-sites/handbook/-/jobs/5968799321#L123):

```plain
Error: error building site: failed to render shortcode: "/builds/gitlab-com/content-sites/handbook/content/handbook/product/ux/technical-writing/_index.md:126:1": failed to render shortcode "tech-writing": failed to process shortcode: "/builds/gitlab-com/content-sites/handbook/layouts/shortcodes/tech-writing.html:16:28": execute of template failed: template: shortcodes/tech-writing.html:16:28: executing "shortcodes/tech-writing.html" at <ref page (printf "/handbook/product/categories#%s-section" $section)>: error calling ref: parse "/handbook/product/categories#%!s(<nil>)-section": invalid URL escape "%!s"
Error: error building site: failed to render shortcode: "/builds/gitlab-com/content-sites/handbook/content/handbook/marketing/technical-writing/_index.md:126:1": failed to render shortcode "tech-writing": failed to process shortcode: "/builds/gitlab-com/content-sites/handbook/layouts/shortcodes/tech-writing.html:16:28": execute of template failed: template: shortcodes/tech-writing.html:16:28: executing "shortcodes/tech-writing.html" at <ref page (printf "/handbook/product/categories#%s-section" $section)>: error calling ref: parse "/handbook/product/categories#%!s(<nil>)-section": invalid URL escape "%!s"
```

Following the error trace, notice that the last error with a full path and line number is:
+2 −2
Original line number Diff line number Diff line
@@ -117,7 +117,7 @@ One way to create inclusion among your remote staff is to remove time zone bias

Take initiative to operate [asynchronously](asynchronous/) whenever possible. This shows care and consideration for those who may not be in the same time zone, are traveling outside of their usual time zone, or are [structuring their day](/handbook/company/culture/all-remote/) around pressing personal or local commitments.

For example, you can record and share team [meetings](meetings/) using GitLab Issues and Merge Requests rather than sending texts, calls, or Slack messages. Be aware of local holidays, personal vacation statuses, and encourage others to default to [documentation](/handbook/product/ux/technical-writing/#documentation) rather than pressuring team members to be online outside of their working hours.
For example, you can record and share team [meetings](meetings/) using GitLab Issues and Merge Requests rather than sending texts, calls, or Slack messages. Be aware of local holidays, personal vacation statuses, and encourage others to default to [documentation](/handbook/marketing/technical-writing/#documentation) rather than pressuring team members to be online outside of their working hours.

## How do I assess culture fit remotely?

@@ -252,7 +252,7 @@ Emna G., founder and CEO at Veamly, spoke with GitLab's [Darren M.](https://twit
>
> If you put structure around this, and you document it, you eliminate the guilt and the fear of missing out. — *Emna G., founder and CEO at Veamly*

It's important for leadership to set the tone, but it's even more important to [document](/handbook/product/ux/technical-writing/#documentation) what will define your culture. Each time a scenario arises where there is no clearly defined answer, look to your company values to determine the answer, and then document.
It's important for leadership to set the tone, but it's even more important to [document](/handbook/marketing/technical-writing/#documentation) what will define your culture. Each time a scenario arises where there is no clearly defined answer, look to your company values to determine the answer, and then document.

Documentation is a shared benefit, and is something that should be embraced by all members of the organization. While it may feel inefficient to document nuances related to culture, creating good habits around this will ensure that culture is as strong in the future as it was in a company's infancy.

+1 −1
Original line number Diff line number Diff line
@@ -242,7 +242,7 @@ As aptly stated in [Basecamp's Handbook](https://basecamp.com/handbook), **there

Remote work enables a great deal of flexibility, freedom, and autonomy. It also requires adaptability when it comes to communication, and may require experimentation by the team member to reach peak enjoyment.

It can be tempting for new remote workers to simply implement tactics used in colocated spaces, but from their home or a co-working space. For example, learning to search for answers within [documentation](/handbook/product/ux/technical-writing/#documentation) rather than tapping someone on the shoulder and asking a question.
It can be tempting for new remote workers to simply implement tactics used in colocated spaces, but from their home or a co-working space. For example, learning to search for answers within [documentation](/handbook/marketing/technical-writing/#documentation) rather than tapping someone on the shoulder and asking a question.

This also applies to more nuanced aspects of work, including employee perception. Whereas working from a unique place or doing things differently may be discouraged in a colocated space, consider celebrating such diversity in a remote space.

+1 −1
Original line number Diff line number Diff line
@@ -184,7 +184,7 @@ Learn more about [using handbook screenshots instead of creating a presentation]

Learn more about the importance of documentation in the GitLab resources below.

1. [Technical Writing handbook section](/handbook/product/ux/technical-writing)
1. [Technical Writing handbook section](/handbook/marketing/technical-writing)
1. [Documentation style guide](https://docs.gitlab.com/ee/development/documentation/styleguide/)
1. [Documentation guidelines](https://docs.gitlab.com/ee/development/documentation/)
1. [Scaling by documenting](/handbook/company/culture/all-remote/)
Loading