Write Technically | Recommended VS Code Extensions

Home
About
Work

Write Technically

Overview

Getting Started

Develop a content strategy
Use the Docs-as-Code strategy
Write your docs
Test your documentation
Documentation reviews

Style Guidelines

Guidelines and best practices
Grammar and mechanics
Interface items and standards
Language and choices
Voice and tone

Tutorials

Follow the Git workflow
Merge request responsibilities

Reference

Recommended VS Code extensions
Helpful resources

Recommended Visual Studio Code extensions

We recommend installing the following extensions for VS code to make writing your docs easier.

Linters

Markdown Lint
Write Good Linter
OpenAPI Lint

Spell checker

Code Spell Checker

Markdown tools

Markdown All-in-One

OpenAPI tools

OpenAPI designer
VS Code YAML

More info

Follow the Git workflow
Helpful resources

Write Technically

Overview

Getting Started

Develop a content strategy
Use the Docs-as-Code strategy
Write your docs
Test your documentation
Documentation reviews

Style Guidelines

Guidelines and best practices
Grammar and mechanics
Interface items and standards
Language and choices
Voice and tone

Tutorials

Follow the Git workflow
Merge request responsibilities

Reference

Recommended VS Code extensions
Helpful resources

Copyright ©2023 Steven Clements — All Rights Reserved.