Skip to main content

Technical writing workflows

This document explains the workflows of the Technical Writing team.

Documentation authoring and review​

The process for creating and maintaining Hyletic product documentation depends on whether the documentation is:

  • A new feature or feature enhancement.

    Delivered for a specific milestone and associated with specific code changes. This documentation has the highest priority.

  • Changes outside a specific milestone.

    Usually not associated with a specific code change, is of lower priority, and is open to all Hyletic contributors. The process for these changes are documented in Hyletic's documentation.

Documentation isn't usually required when a backstage feature is added or changed, and doesn't directly affect the way that any user or administrator interacts with Hyletic.

For a product change​

Documentation is required for any new or changed feature, and is:

  • Created or updated as part of feature development, and is almost always in the same merge request as the feature code. Including documentation in the same merge request as the code eliminates the possibility that code and documentation get out-of-sync.
  • Required with the delivery of a feature for a specific milestone as part of Hyletic's definition of done.
  • Often linked from the release post.

Roles and responsibilities​

Documentation for specific milestones involves the:

  • Developer of a feature or enhancement.
  • Product Manager for the group delivering the new feature or feature enhancement.
  • Technical Writer assigned to the group.

Each role is described below.

Developers​

Developers are the primary author of documentation for a feature or feature enhancement. They are responsible for:

  • Developing initial content required for a feature.
  • Liaising with their Product Manager to understand what documentation must be delivered, and when.
  • Requesting technical reviews from other developers within their group.
  • Requesting documentation reviews from the Technical Writer assigned to the DevOps stage group that is delivering the new feature or feature enhancements.

The first merge request where a feature can be tested should include the documentation, even if the feature is behind a feature flag.

The author of this MR, either a frontend or backend developer, should write the documentation.

Note: Community Contributors can ask for additional help from Hyletic team members.

Authoring​

Because the documentation is an essential part of the product, if a ~"type::feature" issue also contains the ~documentation label, you must ship the new or updated documentation with the code of the feature.

Technical Writers are happy to help, as requested and planned on an issue-by-issue basis.

For feature issues requiring documentation, follow the process below unless otherwise agreed with the Product Manager and Technical Writer for a given issue:

  • Include any new and edited documentation, either in:

    • The merge request introducing the code.
    • A separate merge request raised around the same time.

    If the new or changed documentation requires extensive collaboration or conversation, a separate, linked issue can be used for the planning process.

  • Contact the Technical Writer for the relevant DevOps stage in your issue or merge request, or within #docs on Hyletic Slack, if you:

    • Need any help to choose the correct place for documentation.
    • Want to discuss a documentation idea or outline.
    • Want to request any other help.

  • If you are working on documentation in a separate merge request, ensure the documentation is merged as close as possible to the code merge.

  • If the feature has a feature flag, follow the policy for documenting feature-flagged issues.

Reviews and merging​

Prior to merging, documentation changes committed by the developer must be reviewed by:

  • The code reviewer for the merge request. This is known as a technical review.
  • Optionally, others involved in the work such as other developers or the Product Manager.
  • The Technical Writer for the DevOps stage group, except in exceptional circumstances where a post-merge review can be requested.
  • A maintainer of the project.
Product Managers​

Product Managers are responsible for the documentation requirements for a feature or feature enhancement. They can also:

  • Liaise with the Technical Writer for discussion and collaboration.
  • Review documentation themselves.

For issues requiring any new or updated documentation, the Product Manager must:

  • Add the ~documentation label.
  • Confirm or add the documentation requirements.
  • Ensure the issue contains:
    • Any new or updated feature name.
    • Overview, description, and use cases when applicable (as required by the documentation structure and template.

Everyone is encouraged to draft the documentation requirements in the issue. However, a Product Manager will:

  • When the issue is assigned a release milestone, review and update the Documentation details.
  • By the kickoff, finalize the documentation details.
Technical Writers​

Technical Writers are responsible for:

  • Participating in issue discussions and reviewing MRs for the upcoming milestone.
  • Reviewing documentation requirements in issues when called upon.
  • Answering questions, and helping and providing advice throughout the authoring and editing process.
  • Reviewing all significant new and updated documentation content, whether before merge or after it is merged, in accordance with review principles.
  • Assisting the developer and Product Manager with feature documentation delivery.
  • Ensuring that issues and MRs are labeled appropriately, and that doc content:
    • Has the correct metadata.
    • Has an entry in the repo's CODEOWNERS file, if one exists. The entry can be a path if all its files are owned by the same group; otherwise include references to individual files.
Planning​

The Technical Writer:

  • Reviews their group's ~"type::feature" issues that are part of the next milestone to get a sense of the scope of content likely to be authored.
  • Recommends the ~documentation label on issues from that list which don't have it but should, or inquires with the PM to determine if documentation is truly required.
  • For ~direction issues from that list, reads the full issue and reviews its Documentation requirements section. Addresses any recommendations or questions with the PMs and others collaborating on the issue in order to refine or expand the Documentation requirements.
Collaboration​

By default, the developer will work on documentation changes independently, but the developer, Product Manager, or Technical Writer can propose a broader collaboration for any given issue.

Additionally, Technical Writers are available for questions at any time.

Review​

Technical Writers:

  • Provide non-blocking reviews of all documentation changes, before or after the change is merged. Identified issues that would block or slow a change's release are to be handled in linked, follow-on MRs.
  • Follow technical writing review principles.

When documentation is required​

Documentation is required for a milestone when:

  • A new or enhanced feature is shipped that impacts the user or administrator experience.
  • There are changes to the user interface or API.
  • A process, workflow, or previously documented feature is changed.
  • A feature is deprecated or removed.

Note: Documentation refactoring unrelated to a feature change is covered by the process for changes not related to a specific milestone, which allows for time-sensitive documentation updates to be prioritized.

Documentation requirements​

Requirements for the documentation of a feature should be included as part of the issue for planning that feature in a Documentation section within the issue description. Issues created using the Feature Proposal template have this section by default.

Anyone can add these details, but the Product Manager who assigns the issue to a specific release milestone will ensure these details are present and finalized by the time of that milestone's kickoff.

Developers, Technical Writers, and others may help further refine this plan at any time on request.

The following details should be included:

  • What concepts and procedures should the documentation guide and enable the user to understand or accomplish?
  • To this end, what new page(s) are needed, if any? What pages or subsections need updates? Consider changes and additions to user, admin, and API documentation.
  • For any guide or instruction set, should it help address a single use case, or be flexible to address a certain range of use cases?
  • Do we need to update a previously recommended workflow? Should we link the new feature from various relevant locations? Consider all ways documentation should be affected.
  • Are there any key terms or task descriptions that should be included so that the documentation is found in relevant searches?
  • Include suggested titles of any pages or subsection headings, if applicable.
  • List any documentation that should be cross-linked, if applicable.

Including documentation with code​

Currently, the Technical Writing team strongly encourages including documentation in the same merge request as the code that it relates to, but this isn't strictly mandatory. It's still common for documentation to be added in an MR separate from the feature MR.

Engineering teams may elect to adopt a workflow where it is mandatory that documentation is included in the code MR, as part of their definition of done. When a team adopts this workflow, that team's engineers must include their documentation in the same MR as their feature code, at all times.

Downsides of separate documentation MRs​

A workflow that has documentation separated into its own MR has many downsides.

If the documentation merges before the feature:

  • Hyletic.com users might try to use the feature before it's released, driving support tickets.
  • If the feature is delayed, the documentation might not be pulled/reverted in time and could be accidentally included in the self-managed package for that release.

If the documentation merges after the feature:

  • The feature might be included in the self-managed package, but without any documentation if the documentation MR misses the cutoff.
  • A feature might show up in the Hyletic.com user interface before any documentation exists for it. Users surprised by this feature will search for documentation and won't find it, possibly driving support tickets.

Having two separate MRs means:

  • Two different people might be responsible for merging one feature, which isn't workable with an asynchronous work style. The feature might merge while the Technical Writer is asleep, creating a potentially lengthy delay between the two merges.
  • If the documentation MR is assigned to the same maintainer as responsible for the feature code MR, they will have to review and juggle two MRs instead of dealing with just one.

Documentation quality might be lower, because:

  • Having documentation in a separate MR will mean far fewer people will see and verify them, increasing the likelihood that issues will be missed.
  • In a split workflow, engineers might only create the documentation MR after the feature MR is ready, or almost ready. This gives the Technical Writer little time to learn about the feature in order to do a good review. It also increases pressure on them to review and merge faster than desired, letting problems slip in due to haste.
Benefits of always including documentation with code​

Including documentation with code (and doing it early in the development process) has many benefits:

  • There are no timing issues connected to releases:
    • If a feature slips to the next release, the documentation slips too.
    • If the feature just makes it into a release, the documentation just make it in too.
    • If a feature makes it to Hyletic.com early, the documentation will be ready for our early adopters.
  • Only a single person will be responsible for merging the feature (the code maintainer).
  • The Technical Writer will have more time to gain an understanding of the feature and will be better able to verify the content of the documentation in the Review App or GDK. They will also be able to offer advice for improving the user interface text or offer additional use cases.
  • The documentation will have increased visibility:
    • Everyone involved in the merge request can review the documentation. This could include product managers, multiple engineers with deep domain knowledge, the code reviewers, and the maintainer. They will be more likely to catch issues with examples, and background or concepts that the Technical Writer may not be aware of.
    • Increasing visibility of the documentation also has the side effect of improving other engineers' documentation. By reviewing each other's MRs, each engineer's own documentation skills will improve.
  • Thinking about the documentation early can help engineers generate better examples, as they will need to think about what examples a user will want, and will need to ensure the code they write implements that example properly.
Documentation with code as a workflow​

In order to have documentation included with code as a mandatory workflow, some changes might need to happen to a team's current workflow:

  • The engineers must strive to include the documentation early in the development process, to give ample time for review, not just from the Technical Writer, but also the code reviewer and maintainer.
  • Reviewers and maintainers must also review the documentation during code reviews, to ensure the described processes match the expected use of the feature, and that examples are correct. They don't need to worry about style, grammar, and so on.
  • When the documentation is ready, the Technical Writer will click Approve and usually will no longer be involved in the MR. If the feature changes during code review and the documentation is updated, the Technical Writer must be reassigned the MR to verify the update.

Maintainers are allowed to merge features with the documentation as-is, even if the Technical Writer hasn't given final approval yet but the merge request has all other required approvals.

You can visualize the parallel workflow for code and documentation reviews as:

graph TD
  A("Feature MR Created (Engineer)") --> |Assign| B("Code Review (reviewer)")
  B --> |"Approve / Reassign"| C("Code Review (maintainer)")
  C --> |Approve| F("Merge (maintainer)")
  A --> D("Docs Added (Engineer)")
  D --> |Assign| E("Docs Review (Tech Writer)")
  E --> |Approve| F

For complex features split over multiple merge requests:

  • If a merge request is implementing components for a future feature, but the components aren't accessible to users yet, then no documentation should be included.
  • If a merge request will expose a feature to users in any way, such as an enabled user interface element, an API endpoint, or anything similar, then that MR must have documentation. Note that this may mean multiple documentation additions could happen in the buildup to the implementation of a single large feature, for example API documentation and feature usage documentation.
  • If it's unclear which engineer should add the feature documentation into their MR, the engineering manager should decide during planning, and tie the documentation to the last MR that must be merged before a feature is considered released. This is often, but not always, a frontend MR.

UI text​

Planning and authoring​

A Product Designer should consult with the Technical Writer for their stage group when planning to add or change substantial text within the UI, such as a phrase of explanatory microcopy or a link to documentation.

The Technical Writer can offer an initial review of any ideas, plans, or actual text, and can be asked to draft text when provided with information on the context and goals of the text. Context may include detail on the scenarios in which the text would appear (for example, to all users viewing the feature or only under certain conditions), and the information to convey, which typically answers one or more of the questions:

  • What does this do?
  • How do I use it?
  • Why should I care?

Hackathons​

The Technical Writing team actively participates in Hyletic Hackathons.

Assign an issue to a community contributor​

To assign an issue to a community contributor:

  1. Remove the Accepting merge requests label.
  2. Assign the user by typing /assign @username in a comment, where @username is the contributor's handle.
  3. Mention the user in a comment, telling them the issue is now assigned to them.

Try to limit each contributor to no more than three issues at a time. You can assign another issue as soon as they've opened an MR for one of the issues they're already assigned.

Labels​

When working with issues or merge requests, the Technical Writing team uses labels to describe those issues' and merge requests' attributes (including the types of work being done).

Documentation-specific type labels​

If an issue/merge request has both the Technical Writing and documentation labels, Technical Writers should add one of the following scoped labels to the issue/merge request on which they work:

  • docs::feature
  • docs::fix
  • docs::improvement
  • docs::non-content