Blog - Posts from Portland, Oregon https://www.writethedocs.org/blog/archive/location/portland-oregon/atom.xml 2019-12-03T00:00:00Z ABlog Write the Docs Newsletter – December 2019 https://www.writethedocs.org/blog/newsletter-december-2019/ 2019-12-03T00:00:00Z 2019-12-03T00:00:00Z Write the Docs Team <div class="section" id="write-the-docs-newsletter-december-2019"> <p>Hi everybody! It’s Beth here, with the last issue of 2019. And what a year it’s been! Four conferences (including the recently-wrapped-up <a class="reference external" href="/conf/australia/2019/">Australia conference</a>), more meetups than you can shake a stick at, and an ever-busier community on Slack. For a last dose of conference goodness this year, take a look at the <a class="reference external" href="https://www.youtube.com/watch?v=gLlkOUyx7Ks&amp;list=PLy70RNJ7dYrJPuUTAIOS7vWGw6poKDHtH">videos of the talks from Australia</a> (plus <a class="reference external" href="https://www.flickr.com/photos/writethedocs/albums/72157711813997262">fab photos</a>), which are now available for your enjoyment.</p> <p>And there’s plenty to look forward to in 2020. If you like taking the time to think about the big picture over the holidays, we’d love the gift of your talk proposal for Portland 2020 - the <a class="reference external" href="/conf/portland/2020/cfp/">CFP</a> is open until 10th January. We’re also hoping to have another US conference next year, closer to folks on the East Coast - but this is still unconfirmed. We’ll keep you posted.</p> <p>So that’s all on the news front. We’ve had another month of great conversations and insights from the Write the Docs Slack - enjoy!</p> <div class="section" id="documentation-feedback-widgets-thumbs-up-or-down"> <h2>Documentation feedback widgets - thumbs up or down?</h2> <p>Getting user feedback on your documentation can be challenging, and not just emotionally! This month, our community discussed options for asking for that feedback on our help sites.</p> <p>While most felt that getting direct user feedback was ultimately more useful, often that’s not possible. Implementing a widget that asks users for star ratings or a thumbs up/thumbs down can get you somewhere - but these ratings systems have their challenges.</p> <p>One community member suggested that readers may only rate docs when they’re unhappy with their experience, skewing the results to the negative. Others noted that while these can give an idea of high-level likes and dislikes, a thumbs down alone doesn’t tell you what in a doc needs improving or fixing. One idea was to have a widget where, if you give a thumbs down, you’re prompted to leave a comment. But increasing the friction for providing feedback decreases the amount of feedback you’ll receive.</p> <p>There was another theory for the prevalence of negative comments. Most documentation is written intentionally without the “personal touch” , or without even a byline, that would let our audiences connect with the person behind the writing.</p> <p>Here is some recommended reading:</p> <ul class="simple"> <li><a class="reference external" href="https://kayce.basqu.es/blog/best-practices">Maybe Our Documentation “Best Practices” Aren’t Really Best Practices</a></li> <li><a class="reference external" href="https://optinmonster.com/to-allow-blog-comments-or-not-heres-what-the-data-shows/">To Allow Blog Comments or Not? Here’s What the Data Shows…</a></li> </ul> <p>As well as some tool suggestions:</p> <ul class="simple"> <li><a class="reference external" href="https://delighted.com/">Delighted</a></li> <li><a class="reference external" href="https://usabilla.com/">Usabilla</a></li> <li><a class="reference external" href="https://formkeep.com/">Form Keep</a></li> <li><a class="reference external" href="https://www.uservoice.com/">User Voice</a></li> <li><a class="reference external" href="https://www.satismeter.com/">Satismeter</a></li> </ul> <p>If you want to chat more about feedback widget options, jump into #doc-tools!</p> </div> <div class="section" id="our-favorite-keyboard-shortcuts"> <h2>Our favorite keyboard shortcuts</h2> <p>Nothing makes you more nostalgic for familiar keyboard shortcuts than switching operating systems! Fortunately, many Windows keyboard shortcuts work for Mac if you use Command instead of Ctrl (and vice versa). But getting comfortable takes time. To help you settle into a new OS - or just learn some handy tricks - here’s a roundup of the community’s favorite shortcuts.</p> <ul class="simple"> <li><dl class="first docutils"> <dt>Mac:</dt> <dd><ul class="first last"> <li><strong>Command + Backquote</strong>: switch between windows in one app (eg different browser windows).</li> <li><strong>Command + Tab</strong>: switch to next most recently used app. Command + Shift + Tab to change in the opposite direction; hold Command then hit Tab to cycle through open applications.</li> <li><strong>Command + ~</strong> (tilde): cycle through open windows in the current application.</li> <li><strong>Option + click green button in a window</strong>: maximize the window.</li> </ul> </dd> </dl> </li> <li><dl class="first docutils"> <dt>Windows:</dt> <dd><ul class="first last"> <li><strong>Alt + Tab</strong>: switch to next most recently used app. Alt + Shift + Tab to change in the opposite direction; hold Alt then hit Tab to cycle through open applications.</li> <li><strong>Alt + D</strong>: go to the URL bar (in web browsers).</li> <li><strong>Ctrl + Shift + Esc</strong>: open Task Manager.</li> <li><strong>Windows key</strong>: open the Start menu with the cursor in the Search field.</li> <li><strong>Windows key + arrows</strong>: move application windows on the screen.</li> <li><strong>Windows key + D (or M)</strong>: hide all applications, show the desktop.</li> <li><strong>Windows key + L</strong>: lock the screen.</li> <li><strong>Windows key + P</strong>: open a Project panel that lets you mirror your screen and extend it to other displays.</li> <li><strong>Windows key + X</strong>: open a “god mode” panel with links to common administrative controls like Power Options and Settings.</li> <li><strong>Windows key + Tab</strong>: open workspaces preview</li> <li><strong>F11</strong>: toggle full screen.</li> </ul> </dd> </dl> </li> </ul> <p>We also had one suggestion for Linux: <strong>Alt + Backquote</strong> to switch between windows in a single app (eg different browser windows).</p> <p>One more tip: if you regularly use several operating systems, consider setting up keyboard mapping so your shortcuts stay the same across systems.</p> </div> <div class="section" id="should-documentation-have-a-formal-tone"> <h2>Should documentation have a formal tone?</h2> <p>Is there a requirement for formal tone in documentation? Or is it better for docs to be informal? We had a lively discussion on the topic this month.</p> <p>Our documentarians were mostly of the ‘it depends’ school of thought here - as so often, there are no hard and fast rules. In particular, everyone agreed that the choice depends a lot on what your audience expects. It’s important that your tone should not be jarring, causing it to get in the way of your message.</p> <p>What “informal” means can vary; going for a conversational style doesn’t require being irreverent. You can be professional and conversational at the same time, just as you might be when talking to colleagues or customers in person. Sometimes you’ll find that less-formal third-party material is more popular than the formal material written by the company itself. It’s possible that its more casual tone makes it more approachable.</p> <p>A point in favour of formality is that it can simplify localization. Being too informal can make translation challenging, even more so if you’re using humour. The community was much more wary on the topic of humour: being conversational is one thing, but trying to be funny is a risk. “Documentation should not be about taking chances”.</p> </div> <div class="section" id="how-your-tools-affect-your-writing"> <h2>How your tools affect your writing</h2> <p>Do you feel confined by your tools - do they block your writing? - or do you find them liberating? As we discovered in a recent discussion, it’s very personal.</p> <p>Some find they’re distracted by the formatting possibilities in Flare or Word, preferring the simplicity of plain text or markdown: the constraints can be freeing. Other people find considering the styling (or, for DITA, the semantics) helps them think through the content and its meaning.</p> <p>Thinking about formatting can help you look at your content anew - several said they reorganize the content when formatting. Similarly, regardless of which tool works better, many people felt that switching tools or even the medium (eg computer to paper) helps unblock them when they get stuck. It’s a trick to help your brain look at the problem differently. A similar suggestion <em>(that we unfortunately could not possibly condone - Ed.)</em> was to change your font to Comic Sans.</p> <p>A philosophical question: is the style part of the content? Some see it as totally separate - a layer you add on top once the content is done. For others, the format isn’t meaningfully separate from the content: you can write without styling in mind, but when published, the styling will always affect the reader. In some types of writing the style is hugely important - for example, UI text.</p> <p>What about bold and italics - are they styling? No, they’re markers of meaning: the style of italics represents the intent to emphasize something, regardless of the visual implementation. for example in HTML, using <code class="docutils literal notranslate"><span class="pre">&lt;em&gt;</span></code> (you can change the style but means the same) vs <code class="docutils literal notranslate"><span class="pre">&lt;span</span> <span class="pre">style=&quot;font-style:</span> <span class="pre">italic;&quot;&gt;</span></code>.</p> </div> <div class="section" id="job-posts"> <h2>Job posts</h2> <ul class="simple"> <li><dl class="first docutils"> <dt><a class="reference external" href="https://jobs.writethedocs.org/job/165/content-designer-cloud-platform">Content Designer, Cloud Platform</a></dt> <dd>Atlassian, Sydney</dd> </dl> </li> <li><dl class="first docutils"> <dt><a class="reference external" href="https://jobs.writethedocs.org/job/164/senior-developer-content-designer">Senior Developer Content Designer</a></dt> <dd>Atlassian, Sydney</dd> </dl> </li> <li><dl class="first docutils"> <dt><a class="reference external" href="https://jobs.writethedocs.org/job/163/technical-writer/">Technical Writer</a></dt> <dd>Plaid, San Francisco</dd> </dl> </li> </ul> <p><em>To apply for these jobs and more, visit the</em> <a class="reference external" href="https://jobs.writethedocs.org/">Write the Docs job board</a>.</p> </div> <div class="section" id="community-events-coming-up"> <h2>Community events coming up</h2> <ul class="simple"> <li>03 December - Portland, OR, USA - <a class="reference external" href="https://www.meetup.com/Write-The-Docs-PDX/events/266719892">Organizer plan for 2020</a></li> <li>04 December - Chicago, IL, USA - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-Chicago/events/263576210">Holiday meetup</a></li> <li>05 December - Dallas, TX and Salt Lake City, UT - WTD conference playback, <a class="reference external" href="https://www.meetup.com/wtd-dallas/events/266868842/">Dallas</a> and <a class="reference external" href="https://www.meetup.com/Write-the-Docs-SLC/events/266854224/">SLC</a></li> <li>09 December - Berlin, Germany - <a class="reference external" href="https://www.meetup.com/Write-The-Docs-Berlin/events/266729839">How to prepare yourself for a life of docs-as-code</a></li> <li>12 December - Los Angeles, CA, USA - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-LA/events/266666460">Docs at NASA’s Jet Propulsion Lab!</a></li> <li>12 December - Washington DC, USA - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-DC/events/266689728/">STC Webinar Watch Party: It’s Called Technical Communication for a Reason</a></li> <li>17 December - Seattle, WA, USA - <a class="reference external" href="https://www.meetup.com/Write-The-Docs-Seattle/events/266493266/">Seattle morning social</a></li> <li>18 December - Berlin, Germany - <a class="reference external" href="https://www.meetup.com/Write-The-Docs-Berlin/events/266729948/">Write the Christmas party</a></li> <li>14 January - Ottawa, Canada - <a class="reference external" href="https://www.meetup.com/Write-The-Docs-YOW-Ottawa/events/xtcbgqybccbsb">WTD Ottawa Shopify meetup</a></li> <li>15 January - Toronto, Canada - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-Toronto/events/pcqbmqybccbtb">Write the Docs Toronto</a></li> <li>30 January - Los Angeles, CA, USA - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-LA/events/266786362">John Mitchell on Creativity, work, and the brain</a></li> </ul> <p>And that’s all from us. The newsletter team takes the next month off - so happy holidays, everyone, and see you all in February!</p> </div> </div> Announcing Write the Docs Portland 2020 Call for Proposals https://www.writethedocs.org/conf/portland/2020/news/welcome/ 2019-11-05T00:00:00Z 2019-11-05T00:00:00Z Write the Docs Team <div class="section" id="announcing-write-the-docs-portland-2020-call-for-proposals"> <p>Welcome to the official launch of <a class="reference external" href="https://www.writethedocs.org/conf/portland/2020/">Write the Docs Portland 2020</a>.</p> <p>Today we are announcing our <a class="reference external" href="https://www.writethedocs.org/conf/portland/2020/cfp/">Call for Proposals</a> and <a class="reference external" href="https://www.writethedocs.org/conf/portland/2020/">website</a>. Speaking at Write the Docs is a fantastic way to share your ideas with our inspiring community of documentarians. If there is something you’d really like to see a talk on this year, submit a proposal on it, or refer someone else who would be good!</p> <div class="section" id="id1"> <h2>Call for Proposals</h2> <div class="system-message"> <p class="system-message-title">System Message: INFO/1 (<tt class="docutils">/home/docs/checkouts/readthedocs.org/user_builds/writethedocs-www/checkouts/latest/docs/conf/portland/2020/news/welcome.rst</tt>, line 17); <em><a href="#id1">backlink</a></em></p> Duplicate implicit target name: “call for proposals”.</div> <p>Every year, Write the Docs invites people from all across our community to come up on stage to share their insights and experience. We’re looking for ideas and use-cases from all disciplines and roles, so whether you’re a technical writer, developer, UX designer, community manager, or support professional who cares about content and communication, we want to hear from you!</p> <p>You can read our full <a class="reference external" href="https://www.writethedocs.org/conf/portland/2020/cfp/">Call for Proposals</a> on the website.</p> <p>The Call for Proposals will be open until <strong>Midnight PST 10 January, 2020</strong>.</p> </div> <div class="section" id="tickets"> <h2>Tickets</h2> <p>Tickets will officially go on sale in <strong>January 2020</strong>.</p> <div class="system-message"> <p class="system-message-title">System Message: INFO/1 (<tt class="docutils">/home/docs/checkouts/readthedocs.org/user_builds/writethedocs-www/checkouts/latest/docs/conf/portland/2020/news/welcome.rst</tt>, line 7); <em><a href="#id2">backlink</a></em></p> Duplicate implicit target name: “tickets”.</div> <p>In the meantime, you can see the ticket prices on our <a class="reference external" href="https://www.writethedocs.org/conf/portland/2020/tickets/">Tickets</a> page. As with the previous years, we have tiered pricing to make it fair for everyone. Please buy the ticket that best fits your situation.</p> <p>As always, we keep ticket prices low so that it is accessible to the widest range of people possible. However, if you can’t afford these prices and still wish to attend, please email us at <a class="reference external" href="mailto:portland&#37;&#52;&#48;writethedocs&#46;org">portland<span>&#64;</span>writethedocs<span>&#46;</span>org</a>, and we can see how we can help.</p> <p>We will also open a call for volunteers and organizers soon, both of which are great opportunities to get involved with the community and also receive a free ticket.</p> </div> <div class="section" id="stay-updated"> <h2>Stay Updated</h2> <p>Want to find out what’s happening with the conference, or enjoy our monthly global community newsletter? Sign up to one or more of our <a class="reference external" href="http://eepurl.com/cdWqc5">mailing lists</a>. Your information will never be shared with any third-parties, and you can unsubscribe at any time.</p> <p>Want to connect with other documentarians in real-time? Join our <a class="reference external" href="http://slack.writethedocs.org/">Slack</a>.</p> </div> <div class="section" id="conclusion"> <h2>Conclusion</h2> <p>We hope you will join us in Portland for yet another Write the Docs conference. Whether as a speaker or attendee, you can bet it will be another delightful year.</p> </div> </div> Write the Docs Newsletter – November 2019 https://www.writethedocs.org/blog/newsletter-november-2019/ 2019-11-04T00:00:00Z 2019-11-04T00:00:00Z Write the Docs Team <div class="section" id="write-the-docs-newsletter-november-2019"> <p>Hello, everyone - it’s the November edition of the newsletter!</p> <p>The <a class="reference external" href="/conf/australia/2019/">Sydney conference</a> is coming up in just a few short weeks, on 14th-15th November. Tickets are now sold out, but if you can’t make it, don’t worry - videos of the talks will be up on YouTube shortly after the conference.</p> <p>Looking forward to next year, the site for <a class="reference external" href="/conf/portland/2020/">Portland 2020</a> is live, as is the <a class="reference external" href="/conf/portland/2020/cfp">Call For Proposals</a>. We’d love to hear all your awesome talk ideas, so get working on them! The CFP closes on 10th January, 2020.</p> <p>Finally, we’re formalizing how we change policies, by introducing <a class="reference external" href="/blog/introducing-weps/">Write the Docs Enhancement Proposals</a>. The community has mostly grown organically, but there have been some growing pains as we’ve expanded. Our processes are only loosely defined, which makes it harder for new people to understand who makes decisions and join in leadership positions. So we’re trying WEPs, an idea taken from the open-source ecosystem, to formalize our decision-making. If you’re interested, take a look at the <a class="reference external" href="/blog/introducing-weps/">introduction blog post</a>, which goes into more depth.</p> <p>Onto this month’s articles!</p> <div class="section" id="the-strengths-of-different-backgrounds"> <h2>The strengths of different backgrounds</h2> <p>One of our most wide-ranging discussions this month put the breadth of documentarians’ educational and work backgrounds on full display. It made pretty clear that technical documentation draws folks with an incredible variety of education and experience. Here’s just a sample of some of the different backgrounds, and the strengths people feel they gained through them:</p> <ul class="simple"> <li>Culinary arts and restaurants: experience with managing stress, coping in sink-or-swim situations, and working with diverse groups of people</li> <li>Customer support and tech support: lots of practice at explaining things; appreciation for the value of writing things down</li> <li>Education: well prepared to develop training curriculum and knowledge base content</li> <li>History, philosophy, religion, and ethics: strong reading, writing, and arguing skills, and especially the ability to write <em>quickly</em></li> <li>Library and information science: familiar with information architecture, tools, and technologies</li> <li>Sociology and anthropology: keen human-centric insight and user-focused perspective</li> <li>Technical writing certification or degree: allowed to grow into the role; driven to constantly improve</li> </ul> <p>We could fill an entire newsletter describing the paths people took to their roles in documentation. But no matter how our documentarians all found their way here, we’re glad they did ❤️</p> </div> <div class="section" id="docs-and-design-when-docs-can-t-fix-all-the-things"> <h2>Docs and design: When docs can’t fix all the things</h2> <p>Much as we’d wish otherwise, we don’t usually document perfectly usable software. (Is there such a thing?) And sometimes, the software we’re documenting has major usability problems. A plaintive question about how to document a poorly designed product generated a range of responses - from how to provide feedback about the design and try to improve it, to how to hide or make less prominent less usable portions of the product.</p> <p>So if you’ve got features that “don’t make sense” or don’t seem to fit into the rest of the product you’re tasked with documenting, try these tips from our always-creative community:</p> <ul class="simple"> <li>See whether you can persuade the product dev team to remove not-very-sensible features, or features that seem to have been included by mistake.</li> <li>Create an “Advanced Features” section of the docs and bury information about the features there.</li> <li>Keep the docs about the problematic thing short, but also provide brief warnings about any consequences of trying to use a feature - for example, if it works poorly or has unexpected consequences.</li> <li>Include a recommendation to contact Support before using the problem features (a bit passive-aggressive, but participants agreed that desperate times can call for desperate measures). If you do this, make sure to mention it to Support first!</li> </ul> </div> <div class="section" id="the-challenge-of-giving-difficult-feedback"> <h2>The challenge of giving difficult feedback</h2> <p>Learning how to give constructive criticism - which often really means “negative feedback” - is really important, but not easy, especially with colleagues you don’t know well yet. A manager asked this month, and the community had this advice.</p> <p>Firstly, giving negative feedback is painful, but you have to own it. Don’t distance yourself by saying you’re passing on other people’s feedback when you believe it to be correct. And putting it off won’t help in the long run. The longer you leave it, the more you’re tacitly approving, and the more of a surprise the feedback will be.</p> <p>You can help by making the feedback about behaviour and its outcomes, not the person or how you feel about them. A useful acronym here is BIO: say what Behavior you’re observing (with specific examples), the Impact it has, and give Options for doing it differently. On the impact: for example, if a writer isn’t being concise enough, show how the longwindedness affects the reader. The extra information doesn’t help the user achieve their goals, and actually gets in the way.</p> <p>And make sure you’re also giving positive feedback when your report does things well! It can be tough when the only feedback you hear from your manager is negative.</p> <p>Finally, if you’re concerned about your report taking the feedback badly, it could be worth keeping documentation. If you’re getting complaints about your report from colleagues, get those in writing, and write notes of your meetings with them too.</p> </div> <div class="section" id="you-sing-the-second-person-in-documentation"> <h2>“You”-sing the second person in documentation</h2> <p>Referring to the reader in the <a class="reference external" href="https://en.wikipedia.org/wiki/Grammatical_person">second person</a> can make your writing feel more natural and friendly - but is it always the right choice? There are no hard and fast rules, but here are some guidelines.</p> <p>In most end-user documentation, you can use the second person (“you should do the thing”) rather than the third person (“the administrator should do the thing”, when the admin is your audience). But there are some situations where second person doesn’t work so well. It might be less appropriate if you’re writing in a more formal context. If there are multiple types of readers / users of your system (for example, sysadmins and end users), it might be better to specify which one you’re referring to, as “you” could be ambiguous.</p> <p>You can sometimes avoid specifying the person altogether by writing in the imperative. (eg, “To configure a new foo, use the set command.”) This is good as it’s clear and instructive, and often shorter. “You” and the imperative mood aren’t mutually exclusive as the second person is the only possible implied subject.</p> <p>But only using the imperative can sometimes seem a bit curt. If you like using the second person, but you’re worried about having too many instances of the word “you” in a document, try mixing the second person with the imperative.</p> <p>When in doubt, identify your audience, and see what your style guide has to say!</p> </div> <div class="section" id="from-our-sponsor-a-survey-on-authoring-tools"> <h2>From our sponsor: A survey on authoring tools</h2> <p>This month’s newsletter is sponsored by <a class="reference external" href="https://www.jetbrains.com/">JetBrains</a>:</p> <hr> <table width="100%" border="0" cellspacing="0" cellpadding="0" style="width:100%; max-width: 600px;"> <tbody> <tr> <td width="75%"> <p> "Following the discussion on tools in the last newsletter: JetBrains is a cutting-edge software vendor specializing in the creation of intelligent development tools, who sponsored this year's Write The Docs Prague. They're running a survey about help authoring tools and markup languages that are popular among technical writers: <a class="reference external" href="https://surveys.jetbrains.com/s3/authoring-tools-nl">surveys.jetbrains.com/s3/authoring-tools-nl</a>. Please take a moment to share your experience, to help JetBrains get a bird’s eye view of the documentation developer ecosystem." </p> </td> <td width="25%"> <a href="https://surveys.jetbrains.com/s3/authoring-tools-nl"> <img alt="JetBrains" src="/_static/img/sponsors/jetbrains.png"> </a> </td> </tr> </tbody> </table> <hr><p><em>Interested in sponsoring the newsletter? Take a look at our</em> <a class="reference external" href="/newsletter/sponsorship/">sponsorship prospectus</a>.</p> </div> <div class="section" id="job-posts"> <h2>Job posts</h2> <ul class="simple"> <li><dl class="first docutils"> <dt><a class="reference external" href="https://jobs.writethedocs.org/job/155/software-documentation-evangelist-m-f-d/">Software Documentation Evangelist</a></dt> <dd>Contact Software GmbH - Bremen, Cologne or Berlin</dd> </dl> </li> <li><dl class="first docutils"> <dt><a class="reference external" href="https://jobs.writethedocs.org/job/160/senior-technical-writer/">Senior Technical Writer</a></dt> <dd>NGINX - San Francisco</dd> </dl> </li> <li><dl class="first docutils"> <dt><a class="reference external" href="https://jobs.writethedocs.org/job/159/senior-technical-writer/">Senior Technical Writer</a></dt> <dd>Klarna GmbH - Berlin</dd> </dl> </li> <li><dl class="first docutils"> <dt><a class="reference external" href="https://jobs.writethedocs.org/job/162/senior-technical-content-writer/">Senior Technical Content Writer</a></dt> <dd>Instabase - Remote (North America)</dd> </dl> </li> </ul> <p><em>To apply for these jobs and more, visit the</em> <a class="reference external" href="https://jobs.writethedocs.org/">Write the Docs job board</a>.</p> </div> <div class="section" id="community-events-coming-up"> <h2>Community events coming up</h2> <ul class="simple"> <li>5 November - Tel Aviv, Israel - <a class="reference external" href="https://www.meetup.com/Write-The-Docs-TAplus/events/265349233/">GitHub and Jira and Docs - oh my!</a></li> <li>5 November - New York, NY, USA - <a class="reference external" href="https://www.meetup.com/WriteTheDocsNYC/events/265751514/">Lightning talks</a></li> <li>6 November - Leeds, UK - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-North/events/265096599/">JAMStack for docs: a deep dive into Antora</a></li> <li>7 November - Austin, TX, USA - <a class="reference external" href="https://www.meetup.com/WriteTheDocs-ATX-Meetup/events/265377459/">ATX lunch meetup</a></li> <li>9 November - Bengaluru, India - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-India/events/265991392/">Documentation, design and driving initiatives</a></li> <li>12 November - Bellevue, WA, USA - <a class="reference external" href="https://www.meetup.com/Write-The-Docs-Seattle/events/265937099/">Eastside morning social</a></li> <li>14 November - Sydney, Australia - <a class="reference external" href="/conf/australia/2019/">Write the Docs Australia conference 2019!</a></li> <li>14 November - London, UK - <a class="reference external" href="https://www.meetup.com/Write-The-Docs-London/events/265681650/">Localisation and Guerilla graphics</a></li> <li>14 November - Indianapolis, IN, USA - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-Indy/events/265907667/">November meetup</a></li> <li>14 November - Los Angeles, CA, USA - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-LA/events/265804790/">Sean Marquez and TODO task management</a></li> <li>19 November - Austin, TX, USA - <a class="reference external" href="https://www.meetup.com/WriteTheDocs-ATX-Meetup/events/265298825/">ATX happy hour meetup</a></li> <li>19 November - Boston, MA, USA - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-BOS/events/266142147/">Collaborating with UX Designers</a></li> <li>20 November - Toronto, Canada - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-Toronto/events/pcqbmqyzpbbc/">Write the Docs Toronto</a></li> <li>21 November - Stockholm, Sweden - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-Stockholm/events/265899795/">UX and technical writing</a></li> <li>26 November - Ottawa, Canada - <a class="reference external" href="https://www.meetup.com/Write-The-Docs-YOW-Ottawa/events/xtcbgqyzpbqb/">Ottawa Shopify meetup</a></li> <li>27 November - Dublin, Ireland - <a class="reference external" href="https://www.meetup.com/Write-The-Docs-Ireland/events/266134530/">Minimalism in technical communication</a></li> <li>04 December - Chicago, IL, USA - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-Chicago/events/263576210/">Holiday meetup</a></li> </ul> </div> </div> Introducing Write the Docs Enhancement Proposals https://www.writethedocs.org/blog/introducing-weps/ 2019-10-30T00:00:00Z 2019-10-30T00:00:00Z Write the Docs Team <div class="section" id="introducing-write-the-docs-enhancement-proposals"> <p>Write the Docs began seven years ago with a single conference. It has now grown to multiple conferences worldwide, over 50 international meetups, and <a class="reference external" href="https://www.writethedocs.org/#join-the-community">many other projects</a>.</p> <p>We have often followed the open source philosophy in our community practices, keeping a loose governance model and mostly letting the work speak for itself. However, we’ve been experiencing a number of growing pains with this approach. A loosely defined process makes it much harder for new people to understand and join the community in leadership positions, since they don’t understand how the community actually works. Even folks doing a lot of work in the community are often lost or confused when it comes to projects they aren’t directly involved with.</p> <p>All organizations have power structures, some are just not documented. <a class="footnote-reference" href="#id2" id="id1">[1]</a> Instead of trying to reinvent the wheel, we’ve once again taken an idea from the open source ecosystem: Write the Docs Enhancement Proposals, or WEPs.</p> <div class="section" id="what-is-a-write-the-docs-enhancement-proposal-wep"> <h2>What is a Write the Docs Enhancement Proposal (WEP)</h2> <p>The WEP system is a formalized process for making major policy changes in the community. Previously, our governance was usually defined with some kind of fuzzy consensus on a Slack channel or a meeting at a conference. Going forward, we want to establish a written record that people have time to review and comment on. Importantly, there will also be records of the conversation that lead to a change.</p> <p>We hope that WEPs will make the process of making major changes inside the community more explicit and collaborative. Any contributors can propose WEPs with a well-defined process, and the whole community can follow the process of proposing and implementing WEPs. WEPs are the first major step towards having a more open and defined model for governance, but certainly not the last. All further governance changes are planned to go through the WEP process, so it is truly foundational for future improvements to our community management processes.</p> </div> <div class="section" id="what-is-the-wep-process"> <h2>What is the WEP process?</h2> <p>The WEP process is defined in <a class="reference external" href="https://github.com/writethedocs/weps/pull/1">WEP0</a>, the first ever WEP. WEP0 itself is currently ready for review, following the draft WEP process. This might appear circular at first glance, but we hope that it will showcase how the process works as we adopt it.</p> <p>The high-level overview of the WEP process is as follows, from the perspective of someone proposing a WEP:</p> <ol class="arabic simple"> <li>Talk to people about your idea, and get feedback from other community members</li> <li>Draft and submit a Pull Request on the WEP GitHub Repository, which submits the WEP as a <strong>draft</strong></li> <li><dl class="first docutils"> <dt>The <strong>WEP team</strong> then reviews the Draft WEP to make sure it falls within the WEP guidelines:</dt> <dd><ul class="first last"> <li>Is the WEP well-formed? Does it have all the required sections?</li> <li>Is the WEP specific enough that the outcome of approving it is clear?</li> <li>Is the proposed change within the scope of the WEP process?</li> </ul> </dd> </dl> </li> <li>After the WEP team accepts the draft, it is now <strong>ready-for-discussion</strong>.</li> <li>The WEP team then sets a deadline for discussion, currently 30 days, for community feedback and review</li> <li><dl class="first docutils"> <dt>Once the WEP is <strong>ready-for-discussion</strong> and has a deadline, the Core Ops team announce the WEP in a few defined channels, where interested community members can subscribe</dt> <dd><ul class="first last"> <li>The <code class="docutils literal notranslate"><span class="pre">WEP-announcements</span></code> Slack channel</li> <li>The <code class="docutils literal notranslate"><span class="pre">WEP-announcements</span></code> Email list</li> </ul> </dd> </dl> </li> <li>During this month-long period, the WEP is updated based on incoming feedback, and the community works towards a consensus on the proposed change</li> <li><dl class="first docutils"> <dt>At the deadline, the Core Ops team determines if consensus has been reached</dt> <dd><ul class="first last"> <li>If there is consensus, the WEP is <strong>Accepted</strong>, it will be implemented as specified</li> <li>If there is no consensus, the WEP is either <strong>Rejected</strong> or <strong>Extended</strong> for another month. Extension is available when it seems further activity could lead to consensus.</li> </ul> </dd> </dl> </li> <li>Once the WEP decision is made, another announcement is sent to the defined announcement channels</li> </ol> </div> <div class="section" id="get-involved"> <h2>Get involved</h2> <p>If you want to understand the full policy, we invite you to review and comment on <a class="reference external" href="https://github.com/writethedocs/weps/pull/1">WEP0</a>. We also welcome feedback privately via email at <a class="reference external" href="mailto:support&#37;&#52;&#48;writethedocs&#46;org">support<span>&#64;</span>writethedocs<span>&#46;</span>org</a> if that is more comfortable for you. This is a new process, but we hope it will start to address questions of how change happens in the community.</p> <p>We hope that you’ll take the time to read our proposal and understand how we’re changing the process of making changes in the community. The more engaged folks are with the process, the better the community will be for everyone.</p> <table class="docutils footnote" frame="void" id="id2" rules="none"> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> <tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>A great read if you haven’t already: <a class="reference external" href="https://www.jofreeman.com/joreen/tyranny.htm">https://www.jofreeman.com/joreen/tyranny.htm</a></td></tr> </tbody> </table> </div> </div> Write the Docs Newsletter – October 2019 https://www.writethedocs.org/blog/newsletter-october-2019/ 2019-10-04T00:00:00Z 2019-10-04T00:00:00Z Write the Docs Team <div class="section" id="write-the-docs-newsletter-october-2019"> <p>Hi, everyone, and welcome back to the newsletter after our summer break!</p> <p>Top news this month is our salary survey. It can be tough to work out what “normal” pay is, so Write the Docs is carrying out a <a class="reference external" href="/surveys/salary-survey-sep-2019/">salary survey</a> to try to get some answers. The survey is open until 31st October, and we’ll be publishing the anonymized data for free. Help the community and <a class="reference external" href="https://www.surveymonkey.com/r/wtd-salary-2019">fill it out here</a>!</p> <p>On the events side, I thoroughly enjoyed meeting so many of you at the Prague conference! If you missed it, don’t despair, because <a class="reference external" href="https://www.youtube.com/playlist?list=PLZAeFn6dfHpkpYchP1iFnQnc7i-2xJd0I">all the talks are now up on YouTube</a> for your enjoyment. Plus there’s one last conference to look forward to this year: we’ve announced the <a class="reference external" href="/conf/australia/2019/news/announcing-speakers/">speakers and schedule</a> for Write the Docs Australia, coming up on 14-15 November.</p> <p>So that’s all the news! On to the latest and greatest stories gathered from Slack.</p> <div class="section" id="behind-the-scenes-with-fonts-emojis-and-unicode"> <h2>Behind the scenes with fonts, emojis, and Unicode</h2> <p>This month, a question about icons and fonts provided a goldmine of information about emojis and unicode. Here are a few interesting facts:</p> <ul class="simple"> <li>The “key” underneath all fonts is <a class="reference external" href="https://en.wikipedia.org/wiki/Unicode">Unicode</a>. Fonts just provide glyphs for the underlying Unicode values - and different fonts can have different glyphs for the same Unicode.</li> <li>Fonts and typefaces are not the same! A typeface includes more than one font, as fonts are variations on the base (the typeface).</li> <li>In theory, two typefaces could have very different glyphs for the same Unicode code point, but it’s more standardized these days.</li> <li>On a Mac, to get the correct glyph for a font, search in the <a class="reference external" href="https://support.apple.com/en-us/HT201586">Character Viewer</a> for the Unicode code. You can also mark your favorite emojis in Character Viewer to help you find them quickly.</li> <li>Many apps have an emoji menu (look under “Edit”) that opens Character Viewer.</li> <li>Standard emojis have their own Unicode code points - check out the <a class="reference external" href="https://unicode.org/emoji/charts/full-emoji-list.html">full Emoji list</a>.</li> </ul> <p>Quite a few helpful links were also dropped into the discussion, including:</p> <ul class="simple"> <li><a class="reference external" href="https://www.engadget.com/2010/10/11/mac-101-inserting-or-typing-uncommon-characters/">Mac 101: Inserting or typing uncommon characters</a> by Steven Sande</li> <li><a class="reference external" href="https://office-watch.com/2017/inserting-symbols-is-harder-in-office-for-mac/">Inserting Symbols is harder in Office for Mac</a></li> <li><a class="reference external" href="https://codepen.io/btn-ninja/pen/YrXmax">CodePen for Material Icons codes</a></li> </ul> </div> <div class="section" id="feeling-like-a-fraud-and-how-to-deal-with-it"> <h2>Feeling like a fraud and how to deal with it</h2> <p>It’s totally normal to sometimes feel overwhelmed and to doubt your abilities - especially if you’re writing about unfamiliar products. But there are lots of ways to get back on track. Here are some the community suggested:</p> <ul> <li><p class="first">Insert a hypothetical user into the conversation. That way you function as a user advocate, re-engineering the docs to meet users’ needs and wants. For example, asking “If a user tried to follow these instructions as they are, what info would they be missing?”</p> </li> <li><p class="first">Talk to product managers, subject matter experts, and customer support. These roles may have more information about the users’ requirements.</p> </li> <li><p class="first">Establish some clear, short-term deliverables for your work, to get some early wins and regain confidence.</p> </li> <li><p class="first">Remember that you took time to learn the things you already know, so don’t feel discouraged when you feel like you can’t grasp new material instantly. This work is difficult! Step-by-step, you’ll eventually understand the product and get the knowledge you need.</p> </li> <li><p class="first">Make a list of skills and knowledge that you feel you’re missing, and then work out what you’d need to do to fill the gaps. Or, make a list of specific, concrete things you want to achieve, have achieved, expect to achieve. Involve your manager so you can turn them into actionable goals. Success is a work in progress.</p> <p>If you’re interested in setting clear actionable objectives to improve your performance, check out the <a class="reference external" href="https://en.wikipedia.org/wiki/SMART_criteria">SMART criteria</a>.</p> </li> </ul> </div> <div class="section" id="leading-and-following-finding-a-mentor-being-a-mentor"> <h2>Leading and following: finding a mentor, being a mentor</h2> <p>Another great way to build both your confidence and your abilities is to find a mentor, as we discussed recently in <cite>#career-advice</cite>. General agreement that having a mentor is A Very Good Idea led to some handy info:</p> <ul class="simple"> <li>In the UK, the ISTC has a lightweight <a class="reference external" href="https://www.istc.org.uk/professional-development-and-recognition/mentoring-scheme/">mentoring program</a>. One program participant explained that there aren’t many guidelines, so they set up a development plan with their mentee and gave feedback on the mentee’s CV.</li> <li>It can help to draft a development plan to show to a potential mentor, so they know what you’re looking for. For ideas, see the ISTC’s <a class="reference external" href="https://www.istc.org.uk/professional-development-and-recognition/continuing-professional-development/example-cpd-records/">Example CPD Records</a>.</li> <li>Some companies provide formal mentoring programs: people who want to mentor sign up and describe their expertise, and you contact them if you want to be mentored. These programs typically provide internal resources for mentors and mentees as well.</li> <li>A useful article: <a class="reference external" href="https://www.themuse.com/advice/be-my-mentor-craft-the-perfect-email-to-someone-you-admire">How to Email a Potential Mentor the Right Way</a>.</li> </ul> <p>A couple of contributors suggested that WTD start its own mentoring program, which sounds like an idea we’d love someone to take on! If you’re interested, <cite>#meta</cite> is a good place for that conversation. And if this topic captures your interest, see Arran Southall’s talk from Prague this year, <a class="reference external" href="https://www.youtube.com/watch?v=rom6UW-TjNc&amp;list=PLZAeFn6dfHpkpYchP1iFnQnc7i-2xJd0I&amp;index=18">Fostering Talent: Mentorship, Peer Reviews and Going Beyond Your Job Description</a>.</p> <p>(Side note: One <em>could</em> argue that we shouldn’t use the term “mentee”. Classically speaking, the right word for someone being guided by a Mentor is, of course, a “<a class="reference external" href="https://en.wikipedia.org/wiki/Mentor_(Odyssey)#Mentor_as_term">Telemachus</a>”.)</p> </div> <div class="section" id="deciding-on-a-new-tool"> <h2>Deciding on a new tool…</h2> <p>If you’re struggling with the limitations of your docs tools, how do you decide what system to migrate to? In a recent coversation about trying to replace an old CMS, documentarians on Slack compared MadCap Flare, Paligo, static site generators and Adobe Suite, among others.</p> <p>There was some consensus around establishing your specific business requirements before selecting a tool. What outputs do you need to publish? How much do you need to reuse content? Does OS compatibility matter? How long will migration take? The requirements matter because no single tool is right for all situations. If you understand your needs well, it’ll really help - you might even realise that you don’t need to switch.</p> <p>Separating features into must-haves and nice-to-haves makes evaluating tools easier. Take care not to get side-tracked by features that don’t address an actual need you have! Someone posted a useful <a class="reference external" href="http://lauriston.com/requirements_sanitized.pdf">list of features</a> to use as a starting point for your own evaluation.</p> <p>There are many tools out there, and no one size fits all; make sure you know what you need before picking one.</p> </div> <div class="section" id="and-migrating-to-a-new-tool"> <h2>… and migrating to a new tool</h2> <p>Migrating docs from one tool to another is hard, and the bigger the doc set, the harder it is. On top of the technical challenges, there can be content problems too: what do you do if the docs are in dire need of revision?</p> <ul> <li><p class="first">The community agreed that it’s not wise to try to improve docs as the same time as moving. Migrations are hard enough as it is! Better to resist the urge to edit as you go, and improve things in a second phase after the move.</p> </li> <li><p class="first">Alternatively, weed your docs beforehand. Carry out a content audit to make sure what you’re moving is worth the time and trouble. Some bad content you can abandon and start over.</p> <p>Some useful rubrics: ROT (Redundant, Outdated, Trivial); OUCH (Outdated, Unneeded, Current, Have to write); MUSTY (Misleading, Ugly, Superseded, Trivial, Your collection has no need of this - discard it!).</p> </li> <li><p class="first">Everyone agreed they’d underestimated how long a migration would take. Consider migrating in stages, starting with pilot docs that you’re confident will work well in the new tool. This lets you learn about problems nice and early. Ideally the pilot docs should have updates on the horizon but not imminent - it’ll take longer to move than you think.</p> </li> <li><p class="first">Be wary if you’re expected to keep up your normal work at the same time. Lots of people recommended having headcount dedicated to the task. It’s often a good subject for contractors or interns, because the projects don’t require that much context.</p> </li> </ul> <p>If you’re looking for somewhere to chat about these decisions, head over to <cite>#doc-tools</cite>!</p> </div> <div class="section" id="featured-jobs"> <h2>Featured jobs</h2> <ul class="simple"> <li><dl class="first docutils"> <dt><a class="reference external" href="https://jobs.writethedocs.org/job/146/documentation-engineer/">Documentation Engineer</a></dt> <dd>Balena, remote</dd> </dl> </li> <li><dl class="first docutils"> <dt><a class="reference external" href="https://jobs.writethedocs.org/job/152/technical-writer/">Technical Writer</a></dt> <dd>Memsource</dd> </dl> </li> <li><dl class="first docutils"> <dt><a class="reference external" href="https://jobs.writethedocs.org/job/148/senior-technical-writer/">Senior Technical Writer</a></dt> <dd>Kiwi.com, Brno or Prague, Czechia</dd> </dl> </li> </ul> <p><em>To apply for these jobs and more, visit the</em> <a class="reference external" href="https://jobs.writethedocs.org/">Write the Docs job board</a>.</p> </div> <div class="section" id="community-events-coming-up"> <h2>Community events coming up</h2> <ul class="simple"> <li>10 October - Wylie, TX, USA - <a class="reference external" href="https://www.meetup.com/wtd-dallas/events/nmnzfryznbnb/">Doc discussions</a></li> <li>15 October - Austin, TX, USA - <a class="reference external" href="https://www.meetup.com/WriteTheDocs-ATX-Meetup/events/265378713/">Five things to learn from LEGO</a></li> <li>17 October - Denver, CO, USA - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-Boulder-Denver/events/265316110/">Hacktoberfest 2019: An evening of open source collaboration</a></li> <li>24 October - Austin, TX, USA - <a class="reference external" href="https://www.meetup.com/WriteTheDocs-ATX-Meetup/events/265298604/">Happy hour meetup</a></li> <li>24 October - San Francisco, CA, USA - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-Bay-Area/events/265079568/">How and why one company built a documentation app, with Ember.JS</a></li> <li>29 October - Ottawa, Canada - <a class="reference external" href="https://www.meetup.com/Write-The-Docs-YOW-Ottawa/events/xtcbgqyznblb/">Shopify meetup</a></li> <li>29 October - Toronto, Canada - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-Toronto/events/pcqbmqyznbvb/">Write the Docs Toronto</a></li> <li>29 October - Karlsruhe, Germany - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-Karlsruhe/events/264985964/">AsyncAPI Swagger for MQTT? Automated documentation of event-based APIs</a></li> <li>30 October - Chicago, IL, USA - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-Chicago/events/263576196/">October meetup</a></li> <li>05 November - Tel Aviv, Israel - <a class="reference external" href="https://www.meetup.com/Write-The-Docs-TAplus/events/265349233/">GitHub and Jira and Docs - oh my!</a></li> <li>06 November - Leeds, UK - <a class="reference external" href="https://www.meetup.com/Write-the-Docs-North/events/265096599/">Take a deep dive into Antora</a></li> </ul> </div> </div> Highlights and thanks from the Prague conference https://www.writethedocs.org/conf/prague/2019/news/thank-you-recap/ 2019-09-22T00:00:00Z 2019-09-22T00:00:00Z Write the Docs Team <div class="section" id="highlights-and-thanks-from-the-prague-conference"> <p>Hello everyone,</p> <p>As we wrap up the Prague conference, we wanted to send out a quick email to thank everyone for helping to make our sixth European conference such a success. Whether you joined us in person or watched from afar, we thought you might like to get some of the highlights!</p> <div class="section" id="conference-recap"> <h2>Conference recap</h2> <p>At nearly 300 people, this year’s conference was our biggest European event to date! We had the usual mix of main stage and lightning talks, unconference sessions, writing sprints, and social events.</p> <p>We were also pleased with the continued success of our most recent experiments, including live-streaming the talks, running real-time captioning for the main stage, and hosting an in-person job fair. The overall feedback on all of these was positive, and we are excited to carry them forward to future events.</p> <p>Overall, we were so excited to see another conference come together and see our awesome community gather under one roof.</p> </div> <div class="section" id="videos-and-photos"> <h2>Videos and photos</h2> <p>Videos of all the main talks are now available <a class="reference external" href="https://www.youtube.com/playlist?list=PLZAeFn6dfHpkpYchP1iFnQnc7i-2xJd0I">in a playlist on our YouTube channel</a>. We’re still missing a lightning talk video because it required special processing, but we will post it on Slack and Twitter when it’s ready.</p> <p>Thanks to our media sponsor <a class="reference external" href="https://www.bartatwork.com/atwork/">Bart at Work</a> for doing such a great job with these. You can also subscribe to our <a class="reference external" href="https://www.youtube.com/channel/UCr019846MitZUEhc6apDdcQ">YouTube channel</a> so you don’t miss any future content!</p> <p>Photos from the event are available on <a class="reference external" href="https://flic.kr/s/aHsmGXavWt">Flickr</a>, thanks to our wonderful photographer <a class="reference external" href="https://twitter.com/goatlady">Kay Smoljak</a>! We really love the photos each year, and you’re welcome to use them for non-commercial purposes, as per our <a class="reference external" href="https://creativecommons.org/licenses/by-nc-sa/2.0/">Creative Commons License</a>.</p> </div> <div class="section" id="code-of-conduct-transparency-report"> <h2>Code of Conduct transparency report</h2> <p>As with any Write the Docs event, this conference was covered by our <a class="reference external" href="https://www.writethedocs.org/code-of-conduct/">community Code of Conduct</a>. We aim to be as transparent with CoC incidents and enforcement as we can.</p> <p>To ensure that our CoC was visible and accessible, we took a number of specific steps:</p> <ul class="simple"> <li>Every participant agreed to the CoC in advance.</li> <li>The CoC, or a summary, was included on the conference website, conference booklet, and in posters around the conference venue.</li> <li>The CoC was repeatedly mentioned in announcements on the stage.</li> <li>We specifically stressed that the CoC applies to all conference spaces including the social event, and therefore attendees should drink responsibly.</li> <li>We encouraged all attendees to report any incident, even if they were not sure whether it was a violation.</li> </ul> <p>None of our organizers were approached about any CoC concerns at this event. We know that this is, in part, a reflection of the thoughtful and inclusive community that we’re so lucky to have.</p> <p>That being said, we’re also very conscious of the fact that just because nothing was reported doesn’t mean nothing happened. If there was any personal conduct or other aspect of the conference experience that did not meet the expectations of behavior set out in the CoC, please email us at <a class="reference external" href="mailto:conduct&#37;&#52;&#48;writethedocs&#46;org">conduct<span>&#64;</span>writethedocs<span>&#46;</span>org</a>.</p> </div> <div class="section" id="ready-for-more"> <h2>Ready for more?</h2> <p>We still have our third <a class="reference external" href="https://www.writethedocs.org/conf/australia/2019/">Australia conference</a> in November. Tickets are still available and the list of talks is now published on the website.</p> <p>We also announced the dates for next year’s <a class="reference external" href="https://www.writethedocs.org/conf/portland/2020/">Portland conference</a>, and you can sign up for that mailing list to get updates when tickets go on sale and the Call for Proposals opens.</p> </div> <div class="section" id="thanks-again"> <h2>Thanks again</h2> <p>We’re so grateful to our speakers, sponsors, volunteers, and attendees for making this conference possible. Whether you were able to join us this time or not, we hope to see you back in Prague next year&nbsp;– or even sooner at one of our other events!</p> </div> </div> Write the Docs 2019 Community Update https://www.writethedocs.org/blog/write-the-docs-mid-year-update-2019/ 2019-09-11T00:00:00Z 2019-09-11T00:00:00Z Eric Holscher <div class="section" id="write-the-docs-2019-community-update"> <p>Hey there documentarians!</p> <p>The newsletter team is taking the month off, but that doesn’t mean the community is standing still. We’re sending out a (somewhat belated :D) update to let you know about a few things we’re working on while they take a much deserved break.</p> <p>We’re looking forward to seeing everyone in <a class="reference external" href="http://www.writethedocs.org/conf/prague/2019/">Prague</a> in a few days. If you aren’t able to make it, check out the our experimental <a class="reference internal" href="../../../../conf/prague/2019/livestream/"><span class="doc">livestream</span></a> of the event and join us in <cite>#live-streaming</cite> channel on Slack.</p> <p>We’re also getting excited about our upcoming <a class="reference external" href="http://www.writethedocs.org/conf/australia/2019/">Australia</a> conference in Sydney on November 14-15. The speaker list will be announced soon and the conference is coming up in a couple months, so start making your travel plans.</p> <p>Lastly, we’ve also announced the dates for the <a class="reference external" href="http://www.writethedocs.org/conf/portland/2020/">Portland</a> conference next year on May 3-5, 2020. The sponsorship prospectus and a landing page are now online, with more updates on that conference in the coming months.</p> <div class="section" id="salary-survey"> <h2>Salary Survey</h2> <p>The thing that we’re most excited about is our new <a class="reference internal" href="../../../../surveys/salary-survey-sep-2019/"><span class="doc">Salary Survey</span></a>. Our goal is to get a clear idea of the pay scales and benefits in the software industry around documentation. Publishing the anonymized results for free will help people get a better understanding of what an appropriate salary is, and negotiate a better one.</p> <p>The survey is 21 questions broken up into 4 parts and all questions are optional if you aren’t comfortable answering them. You can fill it out here: <a class="reference external" href="https://www.surveymonkey.com/r/wtd-salary-2019">https://www.surveymonkey.com/r/wtd-salary-2019</a> Please consider sharing it with your network and on social media, as the more data we have the better it is for everyone.</p> <p>The salary will be open until <strong>October 31st, 2019</strong>, after that we will process the data and publish the anonymized results.</p> </div> <div class="section" id="a-us-east-conference"> <h2>A US East Conference</h2> <p>We’re starting to plan another US conference in 2020. We want to make this one somewhere closer to folks on the east coast, but we haven’t figured out exactly where to host it yet.</p> <p>Currently we’re in the process of trying to find suitable venues. There are more details in our <a class="reference internal" href="../../../../conf/cfp/east-2020/"><span class="doc">request for venues</span></a>. If you know of a good venue that you think would work well for a Write the Docs conference, please let us know!</p> </div> <div class="section" id="community-interviews"> <h2>Community Interviews</h2> <p>We have finished up the summer internship that we ran this year with <a class="reference external" href="https://mohitpatel.design/2019/08/13/write-the-docs-internship-retrospective/">Mohit Patel</a>. We now have <a class="reference external" href="http://www.writethedocs.org/hiring-guide/#community-spotlight">13 interviews with people in the community</a> sharing their job history in the industry, as well as suggestions for folks who are just getting started.</p> <p>We’re excited to have this resource available for people who are hoping to get into the industry. It’s often hard to understand how to get started, and having so many different stories and backgrounds really shows there isn’t a “proper” path, but many different ways.</p> </div> <div class="section" id="meetups"> <h2>Meetups</h2> <p>We’re almost at <a class="reference external" href="http://www.writethedocs.org/meetups/">50 meetups</a> now, including a newly created <a class="reference external" href="http://writethedocsremote.tk/#events/">remote meetup</a>! The kick-off event was a few days ago, and we’re eager to hear how it went.</p> <p>Speaking of remote events, on October 7th, Deborah Barnard and Lorna Jane from our North England meetup are running a virtual docs hackathon as part of <a class="reference external" href="https://hacktoberfest.digitalocean.com/">Hacktoberfest</a>, more info at <a class="reference external" href="https://www.starfallprojects.co.uk/blog/hacktoberfest-2019/">https://www.starfallprojects.co.uk/blog/hacktoberfest-2019/</a></p> <p>Also noteworthy is the search for both a San Francisco lead meetup organizer and a Bay Area meetup coordinator. If you’re in the area, and attend meetups regularly, maybe you’d like to find out a little more about what is involved? <a class="reference external" href="https://www.meetup.com/Write-the-Docs-Bay-Area/">https://www.meetup.com/Write-the-Docs-Bay-Area/</a></p> </div> <div class="section" id="featured-jobs"> <h2>Featured jobs</h2> <ul class="simple"> <li><dl class="first docutils"> <dt><a class="reference external" href="https://jobs.writethedocs.org/job/133/technical-writer-content-marketing-it-products/">Technical Writer, Content Marketing (IT products)</a></dt> <dd>Veeam Software</dd> </dl> </li> <li><dl class="first docutils"> <dt><a class="reference external" href="https://jobs.writethedocs.org/job/137/technical-writer/">Technical Writer</a></dt> <dd>Ripple</dd> </dl> </li> <li><dl class="first docutils"> <dt><a class="reference external" href="https://jobs.writethedocs.org/job/140/documentation-technical-content-strategist-ipfs/">Documentation &amp; Technical Content Strategist, IPFS</a></dt> <dd>Protocol Labs</dd> </dl> </li> <li><dl class="first docutils"> <dt><a class="reference external" href="https://jobs.writethedocs.org/job/143/technical-writer-api-products/">Technical Writer - API products</a></dt> <dd>Cytora</dd> </dl> </li> <li><dl class="first docutils"> <dt><a class="reference external" href="https://jobs.writethedocs.org/job/144/technical-writer/">Technical Writer</a></dt> <dd>GitLab</dd> </dl> </li> <li><dl class="first docutils"> <dt><a class="reference external" href="https://jobs.writethedocs.org/job/145/senior-technical-writer/">Senior Technical Writer</a></dt> <dd>GitLab</dd> </dl> </li> </ul> <p><em>To apply for these job, or post your own, visit the</em> <a class="reference external" href="https://jobs.writethedocs.org/">Write the Docs job board</a>.</p> </div> <div class="section" id="thanks"> <h2>Thanks</h2> <p>Thanks again for subscribing to our newsletter and being a member of our community. We hope to see you in person soon at one of our events, or continue to see you online via this newsletter.</p> <p>You can always reply to this email if you have any questions or comments. Stay tuned for another newsletter update next month!</p> </div> </div> Announcing speakers and talks https://www.writethedocs.org/conf/australia/2019/news/announcing-speakers/ 2019-09-11T00:00:00Z 2019-09-11T00:00:00Z Write the Docs Team <div class="section" id="announcing-speakers-and-talks"> <p>G’dday fellow documentarians in Australia and beyond!</p> <p>We’re happy to write to you with the latest news about our upcoming Australian conference, there’s lots to share and with the conference just over two months away, we hope you’re all getting excited!</p> <p>Firstly, we’ve finalised our speakers for the event! Every year talk selection gets more and more difficult as we get a larger, stronger batch of submissions. Thank you so much to everyone who took the time to send us a proposal – we literally wouldn’t have an event without you!</p> <p>We also have some info about ticket purchasing (now’s the time!), call for volunteers, and sponsor updates.</p> <div class="section" id="full-speaker-line-up"> <h2>Full speaker line-up</h2> <p>Every year, we look to bring a wide range of voices to the Write the Docs stage. Because the role of “documentarian” looks so different to each of us, we aim for a line-up that spans a good mix of practical, philosophical, and technical topics – with the odd whimsical one thrown in for good measure. We’re really excited about the presentations we’ve got this year –&nbsp;we hope you are too!</p> <span class="target" id="speaker-australia-2019-paris-buttfield-addison"></span><ul class="simple"> <li>Paris Buttfield-Addison – Making interactive narrative storytelling accessible to everyone</li> </ul> <span class="target" id="speaker-australia-2019-payal-dhiman"></span><ul class="simple"> <li>Payal Dhiman – Being a user’s documentarian: Studying user’s behavior and then defining a strategy for documentation.</li> </ul> <span class="target" id="speaker-australia-2019-rachel-robins"></span><ul class="simple"> <li>Rachel Robins – Supercharge your writing process with a designer’s toolkit</li> </ul> <span class="target" id="speaker-australia-2019-alexander-koren"></span><ul class="simple"> <li>Alexander Koren – Rethinking Release Notes</li> </ul> <span class="target" id="speaker-australia-2019-nithya-krishnan"></span><ul class="simple"> <li>Nithya Krishnan – Minimal Viable Product - What does this mean for user documentation</li> </ul> <span class="target" id="speaker-australia-2019-riona-macnamara"></span><ul class="simple"> <li>Riona MacNamara – Knowledge Is Power: Documentation as a tool for equity and inclusion</li> </ul> <span class="target" id="speaker-australia-2019-fraser-mitchell"></span><ul class="simple"> <li>Fraser Mitchell – Through the looking glass - how user testing can give technical writers better perspective</li> </ul> <span class="target" id="speaker-australia-2019-akhil-behl"></span><ul class="simple"> <li>Akhil Behl – Your First Book - Doesn’t have to be rocket science!</li> </ul> <span class="target" id="speaker-australia-2019-leticia-mooney"></span><ul class="simple"> <li>Leticia Mooney – The amazing, fantastic human bias that makes you bang your head on your desk</li> </ul> <span class="target" id="speaker-australia-2019-alec-clews"></span><ul class="simple"> <li>Alec Clews – Creating API documentation for international communities</li> </ul> <span class="target" id="speaker-australia-2019-elle-geraghty"></span><ul class="simple"> <li>Elle Geraghty – Information architecture for documentation</li> </ul> <span class="target" id="speaker-australia-2019-cameron-shorter"></span><ul class="simple"> <li>Cameron Shorter – TheGoodDocsProject - Doc Fixit</li> </ul> <span class="target" id="speaker-australia-2019-sarah-maddox"></span><ul class="simple"> <li>Sarah Maddox – Kubeflow open source docs need your help!</li> </ul> <span class="target" id="speaker-australia-2019-becky-todd"></span><ul class="simple"> <li>Becky Todd – Git the Docs - A fun, hands-on introduction to version control</li> </ul> <span class="target" id="speaker-australia-2019-sarah-maddox-workshop"></span><ul class="simple"> <li>Sarah Maddox – Tech Writing 101 Workshop</li> </ul> <p>Head over to the <a class="reference external" href="https://www.writethedocs.org/conf/australia/2019/speakers/">Speakers</a> page for full abstracts. We hope there’s something there for everyone to enjoy, and also something that will broaden your horizons a bit.</p> </div> <div class="section" id="call-for-volunteers"> <h2>Call for volunteers</h2> <p>There is plenty to do during the conference and volunteers are essential to the success of all our events! We are looking for folks who are willing to help out during the conference. If you volunteer for two or more shifts (at an average of three hours each), you will receive a free ticket for the conference.</p> <p>We are looking for folks to help out in these roles:</p> <ul class="simple"> <li><strong>Venue set up</strong> - Prepping the main conference hall on Thursday (early morning), including preparing the registration desk, laying out swag, arranging writing day boards, and other light physical labour</li> <li><strong>Workshops/Doc Fixits</strong> - Assisting the Workshops and Doc Fixits speakers, including general information inquiries, directing attendees to specific tables, helping writing day project leads with logistical questions, and other duties as assigned</li> <li><strong>Registration desk/Info</strong> - Registering people in the main conference hall and answering any questions</li> <li><strong>Speakers</strong> - Finding speakers and making sure that they’re where they need to be when it comes time to speak</li> <li><strong>Talk Timing</strong> - Keeping track of the length of the talks and warning speakers when they’re running out of time</li> <li><strong>Unconference</strong> - Camping out in the unconference area downstairs, keeping the place in order, updating unconference room schedule, and so on</li> <li><strong>Venue take down</strong> - What’s more fun than setting things up? Taking them down! Helping with taking down the conference set up and leaving the conference hall better than we found it</li> <li><strong>Sydney expert</strong> - If you are a Sydney local and would like to share your tips and recommendations or answer questions about places to eat, sightseeing, services, accommodation, or other events that are happening around the conference, we’d love to have you on board!</li> <li><strong>Floaters</strong> - Other duties as assigned ;) Assisting with odds and ends, requests from other volunteers and organizers, as well as answering questions; overall, being generally helpful</li> </ul> <p>If you’re not sure how to do any of these tasks, don’t worry, the organisers will be available for questions and any problems you may encounter. We also have a dedicated volunteer coordinator and some volunteers from previous years will join us again, so you will have support.</p> <p>To register as a volunteer for the conference, please read and fill out the <a class="reference external" href="https://forms.gle/KWm4qgHdbSQuwx6x5">Call for Volunteers form</a>. You will receive additional information by mid-October regarding shifts, detailed duties, and other updates to the volunteer duties and schedules.</p> <p>Please email our volunteer coordinator Alexandra Perkins at <a class="reference external" href="mailto:australia&#37;&#52;&#48;writethedocs&#46;org">australia<span>&#64;</span>writethedocs<span>&#46;</span>org</a> if you have any questions about volunteering for the conference.</p> </div> <div class="section" id="tickets-are-going-fast"> <h2>Tickets are going fast!</h2> <p>If you don’t have your ticket yet, now’s a great time to snap one up. Last year we reached capacity a week before the conference, and this year we expect to reach it even sooner (we have already sold out 25% of the tickets), so if you’re planning to come, don’t leave it to the last minute.</p> <p><a class="reference external" href="https://www.writethedocs.org/conf/australia/2019/tickets/">Buy your tickets here!</a></p> </div> <div class="section" id="thanks-to-our-sponsors"> <h2>Thanks to our sponsors</h2> <p>We are so grateful to have our sponsors help in bringing these events to life every year. Thanks sincerely to the following companies for supporting the Write the Docs community:</p> <p><a class="reference external" href="https://www.google.com/">Google</a></p> <p><a class="reference external" href="https://www.knowledgeowl.com/">Knowledgeowl</a></p> <p><a class="reference external" href="https://buildkite.com/">Buildkite</a></p> <p><a class="reference external" href="https://www.gandi.net/en">Gandi.net</a></p> <p><a class="reference external" href="https://datalust.co/seq">Seq</a></p> <p>Want to lend a hand? Head over to our <a class="reference external" href="https://www.writethedocs.org/conf/australia/2019/sponsors/prospectus/">sponsorship prospectus</a> for details on how your company can get involved! We have several types of sponsorship available, and is a great way to support and tap into the growing Australian community.</p> <p>And that’s the latest on the Australian conference. We hope you’re all getting as excited as we are! Stay tuned for more details.</p> <p>The Write the Docs Australia Team</p> </div> </div> Welcome to Write the Docs Prague 2019 https://www.writethedocs.org/conf/prague/2019/news/welcome-getready/ 2019-09-10T00:00:00Z 2019-09-10T00:00:00Z Write the Docs Team <div class="section" id="welcome-to-write-the-docs-prague-2019"> <p>Yet another edition of Write the Docs Prague nearly upon us! We’re excited to see you all in just a few days.</p> <p>Below you’ll find all the practical information you need to navigate the event and activities.</p> <div class="section" id="be-prepared"> <h2>Be prepared</h2> <ul class="simple"> <li><strong>Read the Welcome Wagon Guide.</strong> Our <a class="reference external" href="https://www.writethedocs.org/conf/prague/2019/welcome-wagon/">Welcome Wagon Guide</a> is packed full of information on how to get the most out of the conference. There will also be a few Welcome Wagon events that will help you learn more about the conference.</li> <li><strong>Review the schedule.</strong> The <a class="reference external" href="https://www.writethedocs.org/conf/prague/2019/schedule/">Schedule Page</a> has the latest and most complete information about the presentations and activities. This is where we will also update any changes or cancellations if they occur.</li> <li><strong>Review the Code of Conduct.</strong> We have a wonderful community full of diverse and amazing people. We expect everyone to behave in a respectful manner at all conference events and online channels. Our <a class="reference external" href="https://www.writethedocs.org/code-of-conduct/">Code of Conduct</a> boils down to “Be excellent to each other”, but the <a class="reference external" href="https://www.writethedocs.org/code-of-conduct">full text</a> is also available. Our mobile phone numbers and email addresses are on that page if you ever need to contact us.</li> <li><strong>Review the venue information.</strong> Our <a class="reference external" href="https://www.writethedocs.org/conf/prague/2019/venue/">Venue Page</a> for information about accessibility and orientation. If you have any specific accessibility questions, please email us at <a class="reference external" href="mailto:prague&#37;&#52;&#48;writethedocs&#46;org">prague<span>&#64;</span>writethedocs<span>&#46;</span>org</a> and we will be happy to do our best to make the event as accessible as possible. Once again we will be <em>live captioning</em> all presentations, and priority accessibility seating will be available near the stage.</li> </ul> </div> <div class="section" id="get-involved"> <h2>Get involved</h2> <ul> <li><div class="first system-message"> <p class="system-message-title">System Message: INFO/1 (<tt class="docutils">/home/docs/checkouts/readthedocs.org/user_builds/writethedocs-www/checkouts/latest/docs/conf/prague/2019/news/welcome-getready.rst</tt>, line 7); <em><a href="#id1">backlink</a></em></p> <p>Duplicate explicit target name: “writing day”.</p> </div> <p><strong>Plan a project for Writing Day.</strong> The <a class="reference external" href="https://www.writethedocs.org/conf/prague/2019/writing-day/">Writing Day</a> will be held on Sunday from <em>9:00-17:00</em>, and you can drop in at any time during the day. If you have a project you want to propose to others, you can pitch your topic during the welcome announcement that will be held at <em>10:00</em>. Check out the <a class="reference external" href="https://www.writethedocs.org/conf/prague/2019/writing-day/">Writing Day</a> page for a few suggested projects.</p> </li> <li><p class="first"><strong>Plan a lightning talk.</strong> We’ll have <a class="reference external" href="https://www.writethedocs.org/conf/prague/2019/lightning-talks/">lightning talks</a> each day after lunch. These are 5 minute presentations and a lot of fun. They can be about anything you want; this is your chance to share something you are passionate about with the audience. Slides are not required.</p> </li> <li><p class="first"><strong>Get ready for the Job Fair</strong>. On Tuesday morning we’ll have a <a class="reference external" href="https://www.writethedocs.org/conf/prague/2019/job-fair">job fair</a> where you can find your next documentarian-friendly job.</p> </li> <li><p class="first"><strong>Plan an unconference session.</strong> We’ll be running the <a class="reference external" href="https://www.writethedocs.org/conf/prague/2019/unconference/">Unconference</a> all day Monday and on Tuesday afternoon. Want to chat with like-minded folks about a very specific thing? This is the place. We’ll have a sign-up board so you know what’s happening, and supplies to help you brainstorm.</p> </li> <li><p class="first"><strong>Coffee, breakfast, and lunch are provided on all three days!</strong> Don’t worry about coffee before you come to the conference on Sunday, Monday, or Tuesday. Coffee and breakfast are served at <em>9:00</em> each day, and the conference programme starts at <em>10:00</em>.</p> </li> </ul> </div> <div class="section" id="find-your-way-around"> <h2>Find your way around</h2> <ul class="simple"> <li><strong>Getting around Prague.</strong> Public transit is generally excellent in Prague, and there are private rides and taxi options too. For more information, see our <a class="reference external" href="https://www.writethedocs.org/conf/prague/2019/visiting/">Visiting Prague page</a>, which has all the details you need to get around.</li> <li><strong>Where to go? What do do?</strong> If you want specific food, drink, and sightseeing recommendation, our <em>Visiting Prague Coordinator</em> Jakub Mikuláš (<em>&#64;gak</em> on Slack) will be available on Slack to advise you on the best places to eat, drink, and be merry in and around town.</li> </ul> </div> <div class="section" id="have-fun"> <h2>Have Fun</h2> <ul class="simple"> <li><strong>Join us for the boat ride.</strong> If you’re planning to come for the <a class="reference external" href="https://www.writethedocs.org/conf/prague/2019/outing/">boat ride</a> on Saturday at <em>13:45</em>, make sure you <a class="reference external" href="https://ti.to/writethedocs/write-the-docs-prague-2019/">register in advance</a> . <strong>We are almost at capacity for the boat</strong>, so if you’re on the fence, grab your ticket now! Registrations for the boat ride will close on <em>Friday, September 13th</em>.</li> <li><strong>Pre-register at the welcome reception.</strong> The meet-and-greet event will be held on Sunday from <em>17:00-20:00</em>. You can pick up your badge and enjoy a drink and a snack on us. This is a great chance to meet your fellow documentarians before the conference starts.</li> <li><strong>Relax at the social event on Monday night.</strong> This is a private evening event only for conference attendees. Plan to attend so you can get to know folks in the community. We will be at <a class="reference external" href="https://goo.gl/maps/qJUvEuShp8kUC7ac8">eRKo Gastro Pub (Restaurant by Retro), Francouzská 4, Prague 2</a> on <em>Monday evening from 20:00</em>, with free snacks and drinks while our tab last. A full dinner will not be served, but you should have enough time before we start to grab some dinner if you want a sit-down meal.</li> <li><strong>Participate in the badge flair contest.</strong> What started as an unofficial activity is now a conference tradition. The <a class="reference external" href="https://www.writethedocs.org/conf/prague/2019/badge-flair/">Badge Flair Contest</a> is a fun way to make the most out of your badge flair. We look forward to seeing your creative decorations!</li> <li><strong>Show off your Write the Docs shirt.</strong> If you picked up this year’s shirt at our <a class="reference external" href="https://teespring.com/wtd-prague-2019">T-Shirt Pop-Up Shop</a> we’d love to see you sporting your new threads! And don’t worry, the campaign will run until September 30th in case you still want to order one as a souvenir.</li> </ul> </div> <div class="section" id="share-the-love"> <h2>Share the Love</h2> <ul class="simple"> <li><strong>Slack with your fellow documentarians.</strong> Our <a class="reference external" href="http://slack.writethedocs.org/">Slack</a> is the place to coordinate dinners, ask questions, or share notes with fellow conference attendees. Please use the <strong>#wtd-conferences</strong> or <strong>#prague</strong> channels for group discussions.</li> <li><strong>Use the Twitter hash tag #writethedocs.</strong> Twitter is another great way to communicate at events. If you arrive to Prague early and want to find others, use the hash tag <a class="reference external" href="https://twitter.com/search?q=%23writethedocs&amp;src=tyah">#writethedocs</a>.</li> </ul> <p>We’re so excited to welcome you all to Prague in just a few days – see you there!</p> <div class="line-block"> <div class="line">The Write the Docs team</div> </div> </div> </div> Welcome to Portland 2020 https://www.writethedocs.org/conf/portland/2020/news/init/ 2019-08-21T00:00:00Z 2019-08-21T00:00:00Z Write the Docs Team <div class="section" id="welcome-to-portland-2020"> <p>This is a landing page for our 2020 conference.</p> <p>More information coming soon!</p> </div>
http://www.writethedocs.org/blog/archive/location/portland-oregon/atom.xml
www.writethedocs.org
crawl=CC-MAIN-2019-51
103538
application/http; msgtype=response
sha1:JPMBZQYAXKCXN2HU4MAWRGTCF7SHSGO3
<urn:uuid:9062096d-0b3d-4b45-a3b2-663b3cfec82f>
2019-12-11T20:52:16Z
104.17.32.82
application/atom+xml
sha1:G3WTLB72W5N4YGX4NKDVJYAASLJNHNER
<urn:uuid:5e131121-f8fa-4879-9162-4f2dbc12cc8b>
http://www.writethedocs.org/blog/archive/location/portland-oregon/atom.xml
response
<urn:uuid:9b20c184-9d5a-4696-9593-31cfb4e49534>
isPartOf: CC-MAIN-2019-51
publisher: Common Crawl
description: Wide crawl of the web for December 2019
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-133.ec2.internal
software: Apache Nutch 1.16 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.1-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: http://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/