https://github.com/estruyf/vscode-microsoft-writingstyleguide

Extension that makes your writing better by taking the recommendations from the Microsoft Writing Style Guide into account.
https://github.com/estruyf/vscode-microsoft-writingstyleguide

code vscode vscode-extension vscode-plugin writing

Last synced: 26 days ago
JSON representation

Extension that makes your writing better by taking the recommendations from the Microsoft Writing Style Guide into account.

• Host: GitHub
• URL: https://github.com/estruyf/vscode-microsoft-writingstyleguide
• Owner: estruyf
• License: mit
• Created: 2021-06-21T16:53:26.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-16T08:17:59.000Z (over 2 years ago)
• Last Synced: 2024-05-02T02:18:35.050Z (6 months ago)
• Topics: code, vscode, vscode-extension, vscode-plugin, writing
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=eliostruyf.vscode-microsoft-writingstyleguide
• Size: 1.02 MB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  

    

  



Writing Style Guide




  

    

  

  

  

  

  

    

  



This is a VSCode extension based on the [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/), which helps you to get Microsoft's voice and style when you write about tech. Among other considerations about accessibility guidelines, bias-free communication and in-detail information on grammar, text formatting and capitalization, the guide points out an A-Z word list and term collection, which works as a refernce that can be looked up, when in doubt. 

When authoring a document in Visual Studio Code, you can now use this extension, which will hint you which word or terminology can be improved to match the recommendations from the Writung Style Guide. This means, that you do not need to have an external reference as an author, but can stay in the flow of your work as this extension gives you contextual information right where you need it. Now there is no need anymore to keep the Writing Style Guide website open or go back and forth, switching between writing and editing a document. 

If the extension detects a word listed in the **A-Z word list and term collections**, it shows blue squiggly underlines for the respecting word and displays a contextual popup, which explains the issue. It also links to respecting recommendation in the Writing Style Guide. 

![](./assets/guidance-tooltips.png)

## What is supported

In the current version, the extension supports highlighting the words which you can find 

* in the **A-Z word list and term collections**

* in [Bias-free communication](https://docs.microsoft.com/en-us/style-guide/bias-free-communication)

## Smart Features

The extension will 

* ignore the front matters of an `.md` file

* ignore text in code blocks

* ignore text in inline code blocks

In the sidepanel, you can enable which checks you like to apply: 

![](./assets/sidepanel-actions.png)

## Commands

Currently the extension supports the following commands in VSCode:

![](./assets/commands.png)

- `Writing: Open the Microsoft Writing Style Guide website`

- `Writing: Enable the Microsoft Writing Style Guide` 

  - Extension is enabled by default. If you want to disable it for a project, you can run the disable command.

- `Writing: Disable the Microsoft Writing Style Guide`

  - Allows you to disable the extension for the current project. 

## Work in progress

This extension is still a work in progress.

> Originates from an idea by [Luise Freese](https://github.com/LuiseFreese)