Linting Technical Docs for AI Readability Using Vale
When I started learning more seriously about documentation for AI systems, I noticed something I had probably been ignoring for a long. A lot of documentation problems are not really writing problems but are consistency problems.
The API is PlatformClient on one page and platformClient in an example on another. If you write technical documentation, you can relate to this.
In my docs, one feature is called Form Filling in the navigation, form filling in the body, and Form-Filling somewhere else.
Someone writes:
You might need to create a session before calling the API.
But the session is actually required. None of these things would make me reject a documentation page.
You might even read the page, understand what it means, and move on. But when you maintain a large documentation set, these small differences start showing up everywhere, and now that the same documentation is also being used...
Copyright of this story solely belongs to hackernoon.com. To see the full text click HERE
