Refactor content about Technical Writing team and processes
-
- View options
Description
The Technical Writing team owns content in the following locations:
There is a number of pages that share very similar content across these locations. For example:
- Documentation: public handbook, contribute docs
- Workflow: public handbook, contribute docs
- Topic types: public handbook, contribute docs
Goals
- Determine which content should be made public or internal.
- Identify duplicate content and decide where it best fits.
- Maintain a single source of truth by relying on links instead of duplicating content.
- Propose changes and review with Susan and Suzanne.
- Delete outdated content.
First steps
- Move the examples from Editing content into different topic types to the following docs pages and delete the handbook page:
- In the handbook, integrate Documentation into Technical Writing, get rid of Merging documentation, and delete the child page.
- Integrate Technical Writing workflows into the Documentation workflow docs page and delete the handbook page.
- gitlab!419117.11Merged
- omnibus-gitlab!826017.11Merged
- omnibus-gitlab!825917.11Closed
- gitlab!419017.11Closed
Activity
@susantacker Here's the project we talked about last week. Let me know if I've missed anything. Thank you!
@sselhorn As a Staff TW, what do you think?
- Last reply by Ashraf Khamis
@ashrafkhamis Just letting you know the following page exists -- I assume you already know about it, but just in case. We might want to see if we can keep in sync with the information there: https://docs.gitlab.com/development/code_review/
@susantacker @sselhorn After gitlab-com/content-sites/handbook!12406 (merged) is merged, I'd like to go ahead and move Setting up a local environment to Contribute to the GitLab documentation. It's essentially a single paragraph about tooling that would fit right after the docs page intro.
Since the main Technical Writing page is getting quite long, I've also been thinking about separating out the following sections:
In a way, this would be like a workflow page that could actually remain in the handbook.
Let me know what you think. Thanks!
- Last reply by Ashraf Khamis
Edited by Diana Logan@ashrafkhamis where is the Technical Writing Fundamentals course?
I can search and get a hit for
technical writing fundamentalsin Google, but the page 404s when I link to it. Are we missing a redirect to https://university.gitlab.com/courses/gitlab-technical-writing-fundamentals?
- Last reply by Ashraf Khamis
