Your Docs Are Lying. Here's How to Catch It. | Manny Silva Interview
Technical Writing Uncensored
0:00 / 0:00
Your Docs Are Lying. Here's How to Catch It. | Manny Silva Interview
156 просмотров · 5 месяцев назад
Technical Writing Uncensored
395 подписчиков
156 просмотров · 5 месяцев назад
The evidence gap: a free worksheet for technical writers https://links.dianapayton.com/evidenc...
You led the migration. You built the pipeline. You trained the product managers. And none of it is visible to anyone outside your employer. That gap is the single biggest reason strong writers lose to weaker candidates who happen to have a public repository.
The worksheet shows you what current documentation postings ask you to prove, quoted from live listings so you can go verify it yourself. Then it walks you through inventorying your own work and sorting what you can legally show from what you cannot. Set aside about ninety minutes and bring three real job postings.
I coach senior technical writers who are employed and repositioning into adjacent roles: documentation engineer, content engineer, taxonomist, knowledge architect. If that is where you are headed, book a call here: https://calendly.com/dfhauer/30min
Download Camtasia or SnagIt for a free trial: https://techsmith.z6rjha.net/c/743504...
Learn about the docs as tests approach with technical writing author Manny Silva. See how to improve your documentation workflow.
In this episode of Technical Writing Uncensored, I sit down with Manny Silva to discuss his latest work in the field. We focus on his book, Docs as Tests, and how this methodology changes the way we approach technical documentation. If you are looking to bridge the gap between your testing environment and your user manuals, this conversation offers direct insights into how to integrate these practices effectively.
We also cover the latest updates to Doc Detective, a tool designed to streamline technical writing tasks. Manny explains the new functionality he has added and why these features are useful for technical writers managing complex documentation projects. Whether you are writing books or managing software docs, these updates provide practical ways to automate and verify your content.
Subscribe for weekly technical writing breakdowns, and comment below if you want to see a full tutorial on Doc Detective features.
📚 Resources mentioned:
Doc Detective: https://doc-detective.com
Doc Detective Agent Tools: https://github.com/doc-detective/agen...
Manny's blog, Instruction Manuel: https://instructionmanuel.com/
If you got value from this conversation, please like, subscribe, and hit that bell icon. It really helps the channel.
0:00 Welcome & Intro
1:37 New Book: Docs as Tests and AI
5:34 Doc Detective's Agent Toolkit
9:17 DEMO: Doc Detective Repo Walkthrough
10:32 DEMO: Inline Test Statements Explained
15:15 DEMO: Installing the GitHub Action Skill
18:20 DEMO: Configuring the Workflow (Interactive Setup)
19:48 DEMO: The Self-Healing Loop in Action
23:42 DEMO: Exploring the Agent Skills Repo
30:23 DEMO: The Generate Tests Skill
33:06 DEMO: Custom Agents vs. Skills
34:17 DEMO: Hooks — The Quality Control Layer
36:26 What's Next + How to Get Started
37:04 Outro
#TechnicalWriting #TechComm #DocsAsCode #Documentation #TechnicalWritingUncensored #DocsOrItDidntHappen #DeveloperExperience #WriteTheDocs #KnowledgeManagement #ContentStrategy #TechnicalWriter #TechWriterLife
#TechnicalWritingUncensored #TechnicalWriter #TechnicalWriting #Documentarian #Documentation #WordNerds #TechComm #ContentStrategy #WritingTips #CareerAdvice #UserExperience #DocsLikeCode #TechWritingUncensored #TechCommunity