Skip to content

Latest commit

 

History

History
30 lines (14 loc) · 1.32 KB

software-and-tools.md

File metadata and controls

30 lines (14 loc) · 1.32 KB

Software and tools

"A bad worker blames their tools" -- tools will not help you become a better writer: only practice will do that. That said, why do repetitive manual work when we have robots to do it for us.

Linters

In coding, 'linting' refers to automatically detecting common errors or potential errors, such as unused variables. Text linters use the same idea. You can think of them as advanced spellcheckers.

Alex

Alex is a command-line utility that finds gender favoring, polarizing, race related, religion inconsiderate, or other unequal phrasing in text.

Proselint

Proselint is a command-line utility that collects best practices and common writing errors from several different language guides.

Vale

Vale provides linting through customized style rules. It also has a VSCode extension

API Documentation

API documentation is a technical content deliverable, containing instructions about how to effectively use and integrate with an API.

Swagger

Swagger Swagger takes the manual work out of API documentation, with a range of solutions for generating, visualizing, and maintaining API docs.