|
1 | | -<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="4.4.1">Jekyll</generator><link href="http://localhost:4000/feed.xml" rel="self" type="application/atom+xml" /><link href="http://localhost:4000/" rel="alternate" type="text/html" /><updated>2025-06-06T10:10:53-04:00</updated><id>http://localhost:4000/feed.xml</id><title type="html">Devin Logan, Technical Writer and Editor</title><subtitle></subtitle><author><name> </name></author><entry><title type="html">Getting into technical writing: a primer</title><link href="http://localhost:4000/2025/05/23/primer.html" rel="alternate" type="text/html" title="Getting into technical writing: a primer" /><published>2025-05-23T00:00:00-04:00</published><updated>2025-05-23T00:00:00-04:00</updated><id>http://localhost:4000/2025/05/23/primer</id><content type="html" xml:base="http://localhost:4000/2025/05/23/primer.html"><![CDATA[<p>Over the past few years I’ve talked to a number of people who are interested in getting into the technical writing field. After years of meaning to do this, I finally took some time to write up the thoughts and resources I typically share with people looking to get into the field. This is far from a comprehensive guide and notably doesn’t include much specific resume or cover letter advice.</p> |
| 1 | +<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="4.4.1">Jekyll</generator><link href="http://localhost:4000/feed.xml" rel="self" type="application/atom+xml" /><link href="http://localhost:4000/" rel="alternate" type="text/html" /><updated>2025-06-06T11:03:07-04:00</updated><id>http://localhost:4000/feed.xml</id><title type="html">Devin Logan, Technical Writer and Editor</title><subtitle></subtitle><author><name> </name></author><entry><title type="html">Getting into technical writing: a primer</title><link href="http://localhost:4000/2025/05/23/primer.html" rel="alternate" type="text/html" title="Getting into technical writing: a primer" /><published>2025-05-23T00:00:00-04:00</published><updated>2025-05-23T00:00:00-04:00</updated><id>http://localhost:4000/2025/05/23/primer</id><content type="html" xml:base="http://localhost:4000/2025/05/23/primer.html"><![CDATA[<p>Over the past few years I’ve talked to a number of people who are interested in getting into the technical writing field. After years of meaning to do this, I finally took some time to write up the thoughts and resources I typically share with people looking to get into the field. This is far from a comprehensive guide and notably doesn’t include much specific resume or cover letter advice.</p> |
2 | 2 |
|
3 | 3 | <p>I worked as a technical writer at Google for almost 7 years. (And wrote <a href="https://blog.google/inside-google/life-at-google/sowhat-does-technical-writer-actually-do/">this blog post</a> for Google’s The Keyword back in 2021, which captured my own journey into technical writing.) During that time, I interviewed a lot of candidates, including some people who were switching careers. Now, I’m a freelance technical writer and have spent a lot of time refining my resume and applying to jobs.</p> |
4 | 4 |
|
|
370 | 370 | </li> |
371 | 371 | </ol> |
372 | 372 |
|
| 373 | +<h3 id="added-06-06-2025-adding-a-table-of-contents"><strong><em>Added 06-06-2025</em></strong> Adding a table of contents</h3> |
| 374 | + |
| 375 | +<p>When I initially started writing on this site, I wrote short articles with few to no headings within a post. In the past year or so, though, I’ve been writing some longer pieces with more headings. I thought it would be nice if these posts had tables of contents.</p> |
| 376 | + |
| 377 | +<p>I went back to Claude, of course, to add this to my site.</p> |
| 378 | + |
| 379 | +<ol> |
| 380 | + <li> |
| 381 | + <p>Claude started by giving me three different ways to add it:</p> |
| 382 | + |
| 383 | + <p><img src="/assets/jekyll_site/toc/intro_prompt.png" alt="Claude's initial solution options" /></p> |
| 384 | + </li> |
| 385 | + <li> |
| 386 | + <p>I chose the first solution, using the ‘jekyll-toc’ plugin, because it was “recommended” by Claude and at a glance seemed like the least amount of code. However, I couldn’t get anything to appear on the page.</p> |
| 387 | + |
| 388 | + <p><img src="/assets/jekyll_site/toc/method1.png" alt="Jekyll-toc option" /></p> |
| 389 | + </li> |
| 390 | + <li> |
| 391 | + <p>After an embarassing amount of troubleshooting with Claude, I realized the plugin wasn’t compatible with GitHub Pages, which I use to host the site. So, I switched to trying the Liquid implmentation and it worked right away.</p> |
| 392 | + |
| 393 | + <p>(Actually, Claude told in the beginning that the Liquid solution (second option) was compatible with GitHub Pages. To justify myself, though – Claude didn’t say the ‘jekyll-toc’ plugin <em>wasn’t</em> compatible with GitHub Pages!)</p> |
| 394 | + |
| 395 | + <p><img src="/assets/jekyll_site/toc/liquid_explanation.png" alt="Liquid option" /></p> |
| 396 | + </li> |
| 397 | + <li> |
| 398 | + <p>The implementation was working but was super basic – just a bulleted list.</p> |
| 399 | + |
| 400 | + <p><img src="/assets/jekyll_site/toc/no_css.png" alt="TOC with no CSS" /></p> |
| 401 | + </li> |
| 402 | + <li> |
| 403 | + <p>I had Claude run me up some CSS to create a box around the table of contents:</p> |
| 404 | + |
| 405 | + <p><img src="/assets/jekyll_site/toc/css_prompts.png" alt="TOC with CSS" /></p> |
| 406 | + |
| 407 | + <p>Then, I played with the styling and eventually ended with a grey and italicized Page Contents header.</p> |
| 408 | + |
| 409 | + <p><img src="/assets/jekyll_site/toc/with_css.png" alt="TOC with CSS" /></p> |
| 410 | + </li> |
| 411 | + <li> |
| 412 | + <p>That looked a lot better, but there were still a few functional issues. First, all of the headings were on the same level in the table of contents – an <code class="language-plaintext highlighter-rouge">h2</code> was indistinguishable from an <code class="language-plaintext highlighter-rouge">h3</code>: |
| 413 | + <img src="/assets/jekyll_site/toc/only_one_level.png" alt="TOC with levels" /></p> |
| 414 | + |
| 415 | + <p>I had Claude add some additional CSS to fix this:</p> |
| 416 | + |
| 417 | + <p><img src="/assets/jekyll_site/toc/level_prompts.png" alt="TOC with levels" /></p> |
| 418 | + |
| 419 | + <p>And it worked:</p> |
| 420 | + |
| 421 | + <p><img src="/assets/jekyll_site/toc/correct_levels.png" alt="TOC with levels" /></p> |
| 422 | + </li> |
| 423 | + <li> |
| 424 | + <p>Also, my current implementation wasn’t handling italics (and other styling) in headings:</p> |
| 425 | + |
| 426 | + <p><img src="/assets/jekyll_site/toc/no_italics.png" alt="Italics issue" /></p> |
| 427 | + |
| 428 | + <p>I had to prompt Claude a few different times to fix this:</p> |
| 429 | + |
| 430 | + <p><img src="/assets/jekyll_site/toc/claude_italics_attempts.png" alt="Claude's attempts at fixing the italics issue" /></p> |
| 431 | + |
| 432 | + <p>…and I got some interesting-looking tables of contents in the meantime, but ultimately got it working.</p> |
| 433 | + |
| 434 | + <p><img src="/assets/jekyll_site/toc/no_italics_again.png" alt="Yet another italics issue" /> |
| 435 | + <img src="/assets/jekyll_site/toc/italics_fixed.png" alt="TOC with CSS" /></p> |
| 436 | + </li> |
| 437 | + <li> |
| 438 | + <p>Now every post on my site that has headings also has a table of contents!</p> |
| 439 | + </li> |
| 440 | +</ol> |
| 441 | + |
373 | 442 | <h2 id="takeaways">Takeaways</h2> |
374 | 443 |
|
375 | 444 | <ol> |
|
0 commit comments