> For the complete documentation index, see [llms.txt](https://techwritingtools.gitbook.io/dockit/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://techwritingtools.gitbook.io/dockit/key-features/key-features.md).

# Key Features

A quick summary of DocKit's key features:

**Governance through configurable linting**

1. Two-layered configuration allows you to enable linting through dockit.linting.enabled and select the rules you require through dockit.linting.enabledRules.
2. Wide governance coverage through the built-in Spectral OAS (spectral:oas) rules, and 19 additional dockit-\* rules covering URL conventions, security, naming, developer experience, and lifecycle metadata. Select the rules you need.
3. Rules Reference opens a browsable catalog of available rules, descriptions, and status.

**Configurable style checks**

1. Configurable style checks let you to choose from Google, Microsoft, IBM, write-good, and Alex style rule sets.
2. Easy navigation of style issues in the DocKit Inspector and the VS Code Problems panel.
3. Quick fixes for supported substitutions.

**Extensible spell checking**

1. Improved default dictionary provides better spell checking for API documentation prose.
2. Quickly extend spell checking by adding project-specific words to the dockit.spellCheck.words setting.
3. Build and deploy custom dictionaries with the dockit.spellCheck.customDictionaries setting, which supports up to two custom .txt or .json dictionaries.
4. Quickly review spelling errors in the DocKit Inspector and VS Code Problems panels.
5. Quickly fix spelling issues with available quick fixes in the VS Code editor.
6. Hardened custom dictionary loading secures your environment by restricting custom dictionaries to trusted workspaces and paths within the open workspace, blocking traversal and symlink escapes, and enforcing file and word limits.

 

**Version-aware editor schema validation**

Validates Swagger 2.0, OpenAPI 3.0.x, and OpenAPI 3.1.x documents against the appropriate schema and shows the issues in the DocKit Inspector and VS Code Problems panels.

 

**Export clean public specifications**

1. Remove internal endpoints to create a public specification without the operations or paths marked by a configurable vendor extension.
2. Prune unused components optionally removes components that are not required.

 

**OpenAPI Outline for navigation and discoverability**  

1. Group by Tag groups paths under their tags for easier navigation.
2. Filter on Type limits the Outline to selected element types.
3. Sort By controls ordering within the Outline.
4. Follow Cursor keeps the Outline focused on the element currently being edited.

 

**DocKit on Microsoft's Marketplace portal:** <https://marketplace.visualstudio.com/items?itemName=DocKit.oas-docs>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://techwritingtools.gitbook.io/dockit/key-features/key-features.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.