WTD Episode 16: An open-source Grammarly for tech docs?
Manage episode 344329429 series 3405918
محتوای ارائه شده توسط Write the Docs Podcast. تمام محتوای پادکست شامل قسمتها، گرافیکها و توضیحات پادکست مستقیماً توسط Write the Docs Podcast یا شریک پلتفرم پادکست آنها آپلود و ارائه میشوند. اگر فکر میکنید شخصی بدون اجازه شما از اثر دارای حق نسخهبرداری شما استفاده میکند، میتوانید روندی که در اینجا شرح داده شده است را دنبال کنید.https://fa.player.fm/legal
This episode focuses mainly on testing tools. Last month, some rockstar WTD community members spent a few days at the Pronovix offices in Szeged, Hungary, trying to create a series of open-source testing tools. Specifically, they wanted to create a ‘create a container deployable solution that can automatically check docs’. In more blunt terms, a kind of open-source Grammarly, but integrated into deploys and repositories and focused on tech docs. Host Chris Ward and our podcast guest Anett Pozsar from Szeged (pron. Seg-jed) Hungary also participated in the Test-the-Docs hackathon. Anett recently started in her role as a technical writer, so in this episode we also chat about what it's like starting out as a new technical writer. Finally, we transition from testing tools and linters to templates. Structure and templates can be especially helpful for guiding engineers in writing docs.
…
continue reading
35 قسمت