To support basic quality in your content, you can request an editorial pass from our managed editorial service team.
Scope of service
- The service is available to any technical article contributor, whether you are a content developer, program manager, or in another role.
- The service is available only for C+E technical documentation that will be published to the documentation section of product websites or to TechNet, MSDN, or docs.microsoft.com.
- This service is not intended for content that is not technical documentation (in other words, marketing content, blog posts, and other content that will not be published to a technical documentation library is not eligible for this service). If in doubt, please contact tysonn.
- You can request the edit. Pull request reviewers may also refer authors' articles for edit.
- Edits are usually performed post-publication.
- This service is intended for individual article edits or small batches of edits. If you want to edit a collection of content (more than 10 articles), please contact tysonn and v-tamif to discuss.
To request an edit pass
In the work request, clearly explain the content you need edited – the ticket can be for one article or multiple articles. Please provide:
- The name and URL to the GitHub repository.
- If this is a repo outside the Azure product area, include instructions on how the editors obtain read permissions to your private repository.
- A list of the articles that you want edited - provide the full production URL of each article.
- If you know, please provide a link to the product specific style and terminology guide that applies to the content. The edit team applies a light touch based on the Microsoft Style Guide.
- The URL to the master branch staging URL for the content you want edited.
Understand the process
- The baseline SLA for edit completion is 5 business days. However, the actual delivery of your edits will be based on volume of edit requests.
- The preferred edit process is to edit content after it has been published. This is particularly true of content published from a Git-based repository.
- Notification of start and completion of the edit is via the work item notification from TFS, so make sure you have TFS notifications enabled (Settings>Alerts>New). In GitHub, editors will use the @ syntax (@
) in comments to let you know the edit is ready for review. These mentions send the mentioned user a notification.
- When an edit is complete, the editor notifies the author that the edit is complete and ready for review through the TFS or GitHub notification mechanisms. The author has 5 business days to respond to the request.
- If the author does not respond to the request for review within 5 business days, the editor will sign off on the edit. At this point, the author assumes responsibility for any issues introduced during the edit pass.
Finalize an edit
For GitHub-based content, the edits will be recorded in a pull request. When all edits are agreed to, the author adds the #sign-off comment to indicate the edit is ready to be merged.
Tyson (tysonn) – MSFT project owner and content business SME
Tami (v-tamif) – Aquent editorial service manager
Overall FY18 Vendor Supported Quality Program
The editorial service is one part of the overall support for content quality that Aquent provides to the APEX organization. For more info, see Vendor Supported Quality Program