Just Write Click

Documentation as conversation

  • JustWriteClick
  • Contact
  • Books
  • Introducing Docs Like Code

September 20, 2017 by annegentle Leave a Comment

Podcast interview talking about docs as code with Ellis Pratt of Cherryleaf

Podcast interview talking about docs as code with Ellis Pratt of Cherryleaf

I had a great talk with Ellis Pratt of Cherryleaf Technical Writing consulting last week. Here are the show notes, full of links to all the topics we covered. Podcasts are great fun to listen to and participate in, if a bit nerve-wracking to think on your feet and make sure you answer questions succinctly […]

Filed Under: agile, API, techpubs, tools, work, writing

July 30, 2017 by annegentle Leave a Comment

Investigating Jekyll for versioned content

Investigating Jekyll for versioned content

“Surely I’m overthinking this,” I kept saying to myself, impatiently waiting for a solution to appear before my eyes. I learned that it’s tough to create versioned content with a static site generator, while making sure that the source control system does the version tracking and scripts do the build automation and your theme doesn’t […]

Filed Under: content strategy, techpubs, tools, work, writing Tagged With: jekyll, software, static site, version, web

June 10, 2017 by annegentle Leave a Comment

How Lucas Systems Integrated Swagger OpenAPI Definitions with API Explanations

How Lucas Systems Integrated Swagger OpenAPI Definitions with API Explanations

Now available on docslikecode.com, this explanation of how to integrate Swagger with Swashbuckle for a REST API written with C#. A Pirate’s Life for Me: Documenting APIs with Swagger In it, Adam Locke, their lone tech writer, describes his troubleshooting process, the toolset including DapperDocs, OpenAPI, Nuget, Packet, and some clever code. I appreciate reading […]

Filed Under: techpubs, tools, work, writing Tagged With: openapi, swagger

  • 1
  • 2
  • 3
  • …
  • 176
  • Next Page »

Read More

  • About Anne Gentle
  • Books
    • Conversation and Community
    • Docs Like Code
  • Speaker Profile
  • Contact

Just Write Click in your Inbox

Enter your email address to subscribe to Just Write Click and receive notifications of new posts by email.

Recently on Just Write Click

  • Podcast interview talking about docs as code with Ellis Pratt of Cherryleaf
  • Investigating Jekyll for versioned content
  • How Lucas Systems Integrated Swagger OpenAPI Definitions with API Explanations
  • Versions for docs sites with Jekyll
  • Git and GitHub for Technical Documentation: Reviews
  • JustWriteClick
  • Contact
  • Books
  • Introducing Docs Like Code

Copyright © 2017 · Generate Pro Theme on Genesis Framework · WordPress · Log in