I'm a technical writer based in the San Francisco Bay area of California. Topics I write about on this blog include technical writing, authoring and publishing tools, API documentation, tech comm trends, visual communication, technical writing career advice, information architecture and...

to stay informed about code updates that developers make, and more. For more details, see the post on WTD Podcast. To subscribe to the podcast, see the many many subscription options. Get new posts delivered straight to your inbox. I'm a technical writer based in the California San...

docs are different from code, should we really be treating them the same way? To some extent, sure. But let's not get swept away drinking too much of the docs-as-code koolaid. Get new posts delivered straight to your inbox. I'm a technical writer based in the California San Francisco Bay...

At the last Write the Docs meetup in San Francisco on March 29, we had 11 presenters give lightning talks. This post includes the recordings (audio + slides) of each presenter. There's also a compiled audio file in case you just want to listen to the audio. Lightning talks are a fun format...

Upcoming STC San Francisco presentation: Beyond mere endpoint reference — the overlooked content in API documentation (Feb 21, 2018) I'm giving a presentation to the STC San Francisco chapter called "Beyond mere endpoint reference — the overlooked content in API documentation" on February...

article, I dive into a lot of challenges, decisions, and other details we faced in converting to the docs-as-code model, especially when publishing the output directly from the server. Get new posts delivered straight to your inbox. I'm a technical writer based in the California San...

I recently gave presentation to the Rocky Mountain STC on "Docs-as-code workflows and tools" on March 9, 2018. The docs-as-code approach is most common in the developer doc space. In this presentation, I explore the upsides and downsides of treating documentation as software code, and what...

our documentation processes with build management servers and software release pipelines, will we someday find that doc isn't quite the same as code? Will pushing out that quick fix to address the typo or missing detail become more effort than it's worth? Probably. At the same time, I think...

I know that people get stubborn about tools and tend to put blinders on. Note I'm not singling out Jekyll here as the best tool by any means but rather am referring to the whole genre of docs-as-code tools (which I described at length in Publishing tool options for developer docs). This...

It works with other web tools and other systems too. You can integrate with the latest web technologies and tools. You can leverage help from modern UX devs. Here are some of the revolutionary benefits that docs-as-code tools provide: In my GitHub repo, there are active contributions from...

 

Related shopping

No result