prose https://www.tag1consulting.com/ en Documentation as code: Part 3: A Linting How To - The Vale Linter in action (Demo) - Tag1 TeamTalk #027.3 https://www.tag1consulting.com/blog/documentation-code-linting-part3 <div class="field field--name-body field--type-text-with-summary field--label-hidden field--item"><p>In part 3 of our Tag 1 Team talks about documentation as code: linting for prose, we demonstrate the Vale linter in action. This open-source linter for prose is highly customizable, making it possible for writers with little coding experience or developers with little writing experience to start testing their work.</p><div class="more-link"><a href="/blog/documentation-code-linting-part3" class="more-link" hreflang="en">Read more</a></div></div> <span><span lang="" about="/user/lynette-miles" typeof="schema:Person" property="schema:name" datatype="" content="lynette@tag1consulting.com">lynette@tag1co…</span></span> <span>Mon, 10/26/2020 - 05:32</span> Mon, 26 Oct 2020 12:32:39 +0000 lynette@tag1consulting.com 246 at https://www.tag1consulting.com Documentation as code: Part 2: A Linting How To - What tools are out there and how do they work? - Tag1 TeamTalk #027.2 https://www.tag1consulting.com/blog/documentation-code-linting-part2 <div class="field field--name-body field--type-text-with-summary field--label-hidden field--item"><p>One well-known type of tool in the software world, but less so in the writing world is the linter. Software developers often consider their linters to be invaluable in catching or preventing errors, as well as enforcing defined stylistic guidelines before errors get out in front of the world.</p><div class="more-link"><a href="/blog/documentation-code-linting-part2" class="more-link" hreflang="en">Read more</a></div></div> <span><span lang="" about="/user/lynette-miles" typeof="schema:Person" property="schema:name" datatype="" content="lynette@tag1consulting.com">lynette@tag1co…</span></span> <span>Mon, 10/19/2020 - 10:59</span> Mon, 19 Oct 2020 17:59:31 +0000 lynette@tag1consulting.com 245 at https://www.tag1consulting.com Documentation as code: Part 1: A Linting How To - What, Why, and How? - Tag1 TeamTalk #027.1 https://www.tag1consulting.com/blog/documentation-code-linting-part1 <div class="field field--name-body field--type-text-with-summary field--label-hidden field--item"><p>Documentation is a critical part of any customer-facing product or service. Without it, your customers need hand-holding, your support staff struggles to help your users, and your company spends money on unhappy customers instead of creating new products.</p><div class="more-link"><a href="/blog/documentation-code-linting-part1" class="more-link" hreflang="en">Read more</a></div></div> <span><span lang="" about="/user/lynette-miles" typeof="schema:Person" property="schema:name" datatype="" content="lynette@tag1consulting.com">lynette@tag1co…</span></span> <span>Tue, 10/13/2020 - 06:25</span> Tue, 13 Oct 2020 13:25:29 +0000 lynette@tag1consulting.com 241 at https://www.tag1consulting.com Enabling your developers with docs-as-code methodologies: linting prose https://www.tag1consulting.com/blog/enabling-your-developers-docs-code-methodologies-linting-prose <div class="field field--name-body field--type-text-with-summary field--label-hidden field--item"><p>If you’ve been part of a writing team, known a writer, or ever considered documentation to be an important aspect of your business, you may have heard of docs-as-code. If you haven’t, buckle up, because using these methodologies can lower the bar for your developers to contribute quality documentation to your project. At the same time, it also reduces the work your writing team has to do to ensure your documentation meets your company style and standards. ## Why docs as code? The <a href="https://www.writethedocs.org/">Write the Docs</a> community of technical writers has been exploring the concept of docs as code for years. As a community, they <a href="https://www.writethedocs.org/guide/docs-as-code/">define this concept as</a> <em>a philosophy that you should be writing documentation with the same tools as code:</em> * <em>Issue Trackers</em> * <em>Version Control (Git)</em> * <em>Plain Text Markup (Markdown, reStructuredText, AsciiDoc)</em> * <em>Code Reviews</em> With this philosophy, your writers use the same (or at least similar) tools and workflows as your developers. Your writers can be more easily embedded in your development teams, and can write the first draft of documentation. This speeds final drafts to conclusion. When your writers and developers are using the same tools, collaboration is faster and easier. Writers and...</p><div class="more-link"><a href="/blog/enabling-your-developers-docs-code-methodologies-linting-prose" class="more-link" hreflang="en">Read more</a></div></div> <span><span lang="" about="/user/lynette-miles" typeof="schema:Person" property="schema:name" datatype="" content="lynette@tag1consulting.com">lynette@tag1co…</span></span> <span>Mon, 09/28/2020 - 06:20</span> Mon, 28 Sep 2020 13:20:23 +0000 lynette@tag1consulting.com 229 at https://www.tag1consulting.com