├── .replit ├── course-platforms.md ├── LICENSE ├── software-and-tools.md ├── communities.md ├── README.md ├── write-for-us.md └── resources.md /.replit: -------------------------------------------------------------------------------- 1 | language = "bash" 2 | run = "" -------------------------------------------------------------------------------- /course-platforms.md: -------------------------------------------------------------------------------- 1 | # Education and course publishing platforms 2 | 3 | These section consists of platforms that pay authors/technical writers to write technical courses. 4 | 5 | ## Educative 6 | 7 | Educative hosts and provides interactive courses for software engineers. [Become an educative author](https://learn.educative.io/become-an-educative-author). 8 | 9 | ## Guru99 10 | 11 | Guru99 as a platform provides free training tutorials and videos on IT courses. [Become an instructor](https://www.guru99.com/become-an-instructor). 12 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2020 Gareth Dwyer 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /software-and-tools.md: -------------------------------------------------------------------------------- 1 | # Software and tools 2 | 3 | "A bad worker blames their tools" -- tools will not help you become a better writer: only practice will do that. That said, why do repetitive manual work when we have robots to do it for us. 4 | 5 | ## Linters 6 | 7 | In coding, 'linting' refers to automatically detecting common errors or potential errors, such as unused variables. Text linters use the same idea. You can think of them as advanced spellcheckers. 8 | 9 | ### Alex 10 | 11 | [Alex](https://github.com/get-alex/alex) is a command-line utility that finds gender favoring, polarizing, race related, religion inconsiderate, or other unequal phrasing in text. 12 | 13 | ### Proselint 14 | 15 | [Proselint](https://github.com/amperser/proselint) is a command-line utility that collects best practices and common writing errors from several different language guides. 16 | 17 | ### Vale 18 | [Vale](https://github.com/errata-ai/vale) provides linting through customized style rules. It also has a [VSCode extension](https://github.com/errata-ai/vale-vscode) 19 | 20 | ## API Documentation 21 | 22 | API documentation is a technical content deliverable, containing instructions about how to effectively use and integrate with an API. 23 | 24 | ### Swagger 25 | 26 | [Swagger](https://swagger.io/solutions/api-documentation/) Swagger takes the manual work out of API documentation, with a range of solutions for generating, visualizing, and maintaining API docs. 27 | 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /communities.md: -------------------------------------------------------------------------------- 1 | # Technical writing communities 2 | 3 | There are various communities dedicated to technical writing. Joining these is a great way to get to know other technical writers, learn from experienced technical writers, and find or advertise jobs. They might also host conferences, workshops, or other events. 4 | 5 | ## [Write the Docs](https://www.writethedocs.org) 6 | This is the largest community of technical writers. You can find out more about them on [their website](https://www.writethedocs.org/) or join [their Slack group](https://www.writethedocs.org/slack/) directly. 7 | 8 | ## [TechWriters.dev](https://techwriters.dev) 9 | "A Discord community for folks who are semi-seriously writing or creating tech-related content, roughly in the spirit of the Rands Leadership Slack." [Sign up here](https://techwriters.dev). 10 | 11 | ## [Rands Leadership Slack](https://randsinrepose.com/welcome-to-rands-leadership-slack/) 12 | Focused on leadership and management, but there are active #writing and #i-wrote-something channels where some writers hang out. [Request an invite here](https://randsinrepose.com/welcome-to-rands-leadership-slack/). 13 | 14 | ## [/r/TechnicalWriting](https://www.reddit.com/r/technicalwriting/) 15 | "For people who take the unbelievably complicated things that scientists and engineers devise and make it understandable for non-technical people." 16 | 17 | ## Brian P. Hogan's Discord 18 | Brian is an Editorial Manager at Digital Ocean and is known in the community for technical writing, editing, and mentoring. He runs a private Discord server for writers and content creators. You can request an invite by [contacting Brian](https://bphogan.com/). 19 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Technical Writing 2 | 3 | For some reason, there are only a relatively small number of people who are interested in both technology and language. If you are one of them, technical writing can be a great profession, or means of generating a side income. 4 | 5 | This repository is a collection of technical writing resources. Pull requests to add more resources are highly encouraged. 6 | 7 | ## Writing Resources (Become a better writer) 8 | 9 | [Technical Writing Resources](./resources.md) is a list of books and other resources to help you become a better technical writer 10 | 11 | ## Publishing Resources (Get paid to write) 12 | 13 | [Publishing Resources](./write-for-us.md) provides information on where you can publish your technical posts, and who will pay you for them. 14 | 15 | ## Technical writing communities 16 | [Communities](./communities.md) is a list of communities focused on technical writing. 17 | 18 | ## Software and Tools 19 | [Software and Tools](./software-and-tools.md) is a list of writing tools and other automated programs built to support writers. 20 | 21 | ## About 22 | I used to write technical articles as a freelancer. I'm always surprised that while there are thousands of posts and resources out there relating to helping you become a better (programmer|founder|data scientist|anything else) there is very little about technical writing, and many people don't even know that technical writing is a thing that exists and that pays. 23 | 24 | This is my little attempt to fill that gap. If you have suggestions for more sections, or want to add to existing sections, please submit a pull request. If you're not comfortable with git, [Tweet at me](https://twitter.com/sixhobbits) with your suggestions or use one of the other contact options at the bottom of [my website](https://dwyer.co.za). 25 | 26 | Since creating this, I founded [Ritza](https://ritza.co) - a startup that produces tutorials and documentation for companies and helps them with developer advocacy efforts. Get in touch if you're interested in our services, or if you'd be interested in [writing for us](https://ritza.co/handbook/roles/general-application/). 27 | 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /write-for-us.md: -------------------------------------------------------------------------------- 1 | # Write for us 2 | 3 | A collection of places to publish your writing, with a focus on those that pay for content. 4 | 5 | Once you've honed your technical writing skills with the collection of resources [here](./resources.md), you'll want to start getting your writing out there where people can read it. A common way to start is by creating a Blogger, Wordpress or equivalent page, writing a hello world post, posting another article a week or so later, maybe one more a month later, get discouraged by the fact that you have no viewers, and then an article every 6-12 months starting with "I haven't written on here in a while because...". 6 | 7 | While writing for free for the community is noble, writing is a valued skill, and you can get paid for it. If you write for established companies, you get money and you reach more people, as these companies usually have existing blogs that have an established readership base. Also, by committing to write for a place that pays you, the quality of your content will improve. You'll try harder, and often the company will have an editor go over your work and improve it before publishing. 8 | 9 | # Places that pay for writing 10 | Here's a collection of places looking for freelance technical writers. The going rate is usually about $200 per post. 11 | 12 | ## [Twilio Voices](https://www.twilio.com/voices) 13 | Twilio pays $650 per published post. Tutorials have to contain code, and writers are encouraged to make use of Twilio services for their tutorials. 14 | 15 | ## [Digital Ocean](https://www.digitalocean.com/community/pages/write-for-digitalocean) 16 | Digital Ocean pays writers $300 to write about Python or JavaScript projects or to write tutorials showing how to install and use software (for example, installing Apache2 on Ubuntu). They match the payout with a charitable donation. 17 | 18 | ## [WonderProxy](https://wonderproxy.com/blog/looking-for-authors/) 19 | WonderProxy focuses on automated testing and pays up to $500 for technical tutorials in this area. 20 | 21 | ## [LWN](https://lwn.net/op/AuthorGuide.lwn) 22 | LWN produces articles on Linux and free software. They pay $300 to new authors, but this can be increased for regular authors. There is some related discussion [in this HN thread](https://news.ycombinator.com/item?id=23920240). 23 | 24 | ## [FusionAuth](https://fusionauth.io/blog/) 25 | FusionAuth accepts contributions of 1000-2000 word technical blog posts. They pay $500/post and you get the byline. 26 | They have a number of client libraries ( https://fusionauth.io/docs/v1/tech/client-libraries/ ) and have a pressing need to to get blog posts outlining how to use each one. They're also happy to discuss other possible topics such as OAuth, how to use tokens to protect APIs or integration with a particular CMS. You can reach out to them at marketing |at| fusionauth.io. 27 | 28 | ## [Honeybadger.io](https://www.honeybadger.io/blog/write-for-us/) 29 | Honeybadger is an exception monitoring service which pays writers $500/post. The posts are usually about larger computing topics as they apply to Ruby development. For example, "Everything about character encoding for Rubyists." They do occasionally feature posts about languages other than Ruby. Posts are usually 1500-2500 words and should include code. They don't have to relate to Honeybadger's business of exception monitoring. 30 | 31 | ## [LogRocket](https://blog.logrocket.com/become-a-logrocket-guest-author-7d970eb673f9/) 32 | LogRocket offers up to $300 for topics focussed on front end development, for example React, Redux, Vue.js, webpack, Wasm, MobX, GraphQL, JavaScript, Frontend development best practices, Product/UI/UX design. 33 | 34 | ## [ClubHouse](https://clubhouse.io/clubhouse-write-earn-give-program/) 35 | ClubHouse pays between $350 and $600 and publishes blog posts and tutorials aimed at more senior people: "with a particular focus on engineering leads, managers and VPs/CTOs." 36 | 37 | ## [Auth0](https://auth0.com/apollo-program) 38 | Auth0 pays up to $450, At the moment they are looking for people to help us create content about: Python, Mobile (Native & Cross Platform), Identity and Security,Electron, Java, .NET. 39 | 40 | ## [Linode](https://www.linode.com/docs/contribute/) 41 | Linode is a VPS host that offers up to $300 for technical tutorials relating to Linux. 42 | 43 | ## [Vultr](https://www.vultr.com/docs/vultr-docs-program-guidelines) 44 | Vultr is a VPS provider similar to DigitalOcean and Linode that offers up to $300 for articles on server administration and applications. 45 | 46 | ## [Smashing Magazine](https://www.smashingmagazine.com/write-for-us/) 47 | Smashing Magazine is a longstanding publication that publishes all types of articles for app and web developers and designers. They advertise rates of $200 USD per post. 48 | 49 | ## [Draft.dev](https://draft.dev/write) 50 | Draft.dev focuses on developing technical content and articles for startups and companies. They pay $300+ per article, depending on the technicality of the content. 51 | 52 | ## [neptune.ai](https://neptune.ai/write-for-us) 53 | Netptune.ai focuses on producing technical content for Data Scientists and Machine Learning practitioners. On the same, they pay a considerable amount from $50 - $500. The rate depends on the topic idea, the scope of the article, and its relevance to the Neptune product. 54 | 55 | ## [Vonage](https://learn.vonage.com/spotlight) 56 | Vonage is interested in technical content and tutorials on something unique and original you have built, an innovative use case, or some interesting third-party integrations that use Vonage products. Vonage offers a $500 compensation per post. 57 | 58 | # Writing for exposure 59 | 60 | If you can string sentences together and know a bit about tech, your writing is worth something. However, sometimes it's worthwhile writing for exposure, especially if you haven't written much and you want a portfolio to show off when you pitch to places that pay. Here are some places where you can write for exposure. 61 | 62 | ## [CodeMentor.io](https://www.codementor.io/) 63 | CodeMentor is a mentoring platform where you can get paid by the hour to help people out with issues they face while coding. If you create a profile with codementor, you can publish technical posts and associate them with your profile. CodeMentor promotes selected articles on their main page every day, and this is a good way to get more mentees. You can also apply to write for their blog or community more formally, in which case they'll provide you with an editor to help all the way from outlining through to publication. 64 | 65 | ## [Dev.to](https://www.dev.to/) 66 | DEV is a community of software developers getting together to help one another by sharing helpful content in the form of technical posts, videos and in general helpful discussions. You can publish your content directly once you create a profile or crosspost content from your personal blog if you've got one. The community is welcoming and friendly so it's a great place to grow and get exposure. 67 | 68 | ## [Hashnode.com](https://www.hashnode.com/) 69 | Hashnode is a free developer blogging platform that allows you to publish articles on your own domain and connect with a global developer community. With Hashnode, you can see what others are interested in reading and you can backup your posts to a GitHub repository for safekeeping. 70 | 71 | ## [freeCodeCamp News](https://freecodecamp.org/news) 72 | freeCodeCamp is a non-profit organization that helps make learning to code accessible to anyone. freeCodeCamp News is their free publication and says it "will help you teach developers, designers, and data scientists around the world." Read through [their style guide](https://www.freecodecamp.org/news/developer-news-style-guide/) for general writing style tips and a link to apply for a publishing account. To apply, you'll need to submit three sharable links to example writings you've published before being a contributor writer. 73 | 74 | # Course platforms 75 | 76 | [Course Platforms](./course-platforms.md) are a list of online platforms that produce paid educational content. They pay contributors to create the materials that they sell to their students. 77 | -------------------------------------------------------------------------------- /resources.md: -------------------------------------------------------------------------------- 1 | # Technical Writing 2 | There are a number of resources relating to technical writing, scattered around the web and in print. This is a (growing) list of technical writing resources. Pull requests to add titles are encouraged. Please add the title and a brief summary following the style below. For articles that are available on the web, provide a link. 3 | 4 | ## Books 5 | *The following books are not all specific to technical writing. However, their advice on general writing definitely applies to technical writing as well.* 6 | 7 | ### ['Modern Technical Writing: An Introduction to Software Documentation'](https://www.amazon.com/Modern-Technical-Writing-Introduction-Documentation-ebook/dp/B01A2QL9SS) by Andrew Etter 8 | Written by a professional technical writer at one of Silicon Valley's most exciting companies, Modern Technical Writing is a set of guiding principles and thoughtful recommendations for new and experienced technical writers alike. Not a reference manual, and not comprehensive, it instead serves as an introduction to a sensible writing and publishing process, one that has eluded the profession for too long. 9 | 10 | ### ['On Writing Well: The Classic Guide to Writing Nonfiction'](https://www.amazon.com/Writing-Well-Classic-Guide-Nonfiction/dp/0060891548/ref=sr_1_1?dchild=1&keywords=%27On+Writing+Well%3A+The+Classic+Guide+to+Writing+Nonfiction%27+by+William+Zinsser&qid=1627155584&sr=8-1) by William Zinsser 11 | Zinsser describes writing as a craft, comparing it to carpentry. He focuses on teaching you how to edit, claiming that first drafts are never good. The earlier chapters provide general writing and editing advice, while the later ones are topic-specific and cover travel writing, technical writing, memoir writing, etc. 12 | 13 | ### ['The Elements of Eloquence'](https://www.amazon.com/Elements-Eloquence-Secrets-Perfect-Phrase/dp/042527618X/ref=sr_1_1?dchild=1&keywords=%27The+Elements+of+Eloquence%27+by+Mark+Forsyth&qid=1627155631&sr=8-1) by Mark Forsyth 14 | This book teaches the lost art of rhetoric in a highly entertaining fashion. Each chapter is an explanation -- containing many hilarious and self-describing examples -- of a simple rule to make your writing sound better and be more persuasive. You can read it cover-to-cover, or open it at random. 15 | 16 | ### ['On Writing'](https://www.amazon.com/Writing-Memoir-Craft-Stephen-King/dp/1439193630/ref=sr_1_3?dchild=1&keywords=%27On+Writing%27+by+Stephen+King&qid=1627155683&sr=8-3) by Stephen King 17 | This book is half an autobiography of Stephen King and half writing advice. Although it is aimed more at fiction writers, the advice is generic and sound. The intimate descriptions of the hardships King went through before becoming a famous writer are inspiring. 18 | 19 | ### ['Trees, maps and theorems'](https://www.amazon.com/Trees-Theorems-Effective-Communication-Rational/dp/9081367706/ref=sr_1_1?dchild=1&keywords=%27Trees%2C+maps+and+theorems%27+by+Jean-luc+Doumont&qid=1627155713&sr=8-1) by Jean-luc Doumont 20 | Doumont runs training courses on scientific and technical communication. His book, subtitled 'Effective communication for rational minds', is aimed at technical people who want detailed and practical advice about how to communicate clearly. It does this in a highly structured way with plenty of examples. Later chapters also give advice on presentations, graphical displays and posters. It's also an obsessively edited book. Each minimalist double-page spread has one column of body text and three other columns for common questions, illustrations and examples –– and if you look closely you'll see that the paragraphs have been tweaked to be perfectly rectangular. 21 | 22 | ### ['Style: Toward Clarity and Grace'](https://www.amazon.com/Style-Clarity-Chicago-Writing-Publishing/dp/0226899152/ref=sr_1_1?dchild=1&keywords=%27Style%3A+Toward+Clarity+and+Grace%27+by+Joseph+M.+Williams&qid=1627156022&sr=8-1) by Joseph M. Williams 23 | A slightly older book but still very worth a read. William's strength lies in identifying and naming what it is about difficult sentences that actually makes them difficult for humans to parse. The book starts at the level of individual sentences, walks through plenty of examples of how to polish them for maximal clarity, and later moves onto showing how to build coherent paragraphs and larger bits of text. 24 | 25 | ### ['Practical Typography'](https://practicaltypography.com/) by Matthew Butterick 26 | Formatting and layout of text on a page or screen is an area of writing that's often overlooked or thought of as "someone else's job". However, with the modern prevalence of independent web publishing, where the writer and typographer will often be the same person, it's useful to know the basics of good typography. In describing their typography, Butterick also covers concepts valuable to technical writers such as effective emphasis and how to best present lists and hierarchies of headings. 27 | 28 | The book is available online only at http://practicaltypography.com/ -- as payment, Butterick encourages a donation or a purchase of one of his excellent fonts. 29 | 30 | ### ['The Sense of Style: The Thinking Person's Guide to Writing in the 21st Century'](https://www.amazon.com/Sense-Style-Thinking-Persons-Writing/dp/0143127799/ref=sr_1_2?dchild=1&keywords=%27The+Sense+of+Style%3A+The+Thinking+Person%27s+Guide+to+Writing+in+the+21st+Century%27+by+Steven+Pinker&qid=1627156132&s=books&sr=1-2) by Steven Pinker 31 | Linguist Steven Pinker takes an analytical approach to writing in this style guide, with chapters about reverse-engineering good prose, seeing the grammatical trees in sentences in order to untangle them, and how a writer's intimate knowledge of a subject may distort their writings about it (the biggest problem with much academic and technical writing). Much time is also spent investigating the rules of English grammar and dispelling the many myths that have grown up around it. 32 | 33 | ### ['Technical Blogging'](https://www.amazon.com/Technical-Blogging-Expertise-Remarkable-Presence/dp/1934356883/ref=sr_1_2?dchild=1&keywords=%27Technical+Blogging%27+by+Antonio+Cangiano&qid=1627156220&s=books&sr=1-2) by Antonio Cangiano 34 | This book is, as you may have guessed from the title, specific to technical blogging. "Successful people often get recognition by teaching what they know. Blogging is a reliable path to do that, while gaining influence in the process." Unlike most of the others here, it doesn't focus as much on writing well, but more about how to set up a technical blog, how to promote it and how to find time to write. 35 | 36 | ### ['Software Technical Writing: A Guidebook'](https://jamesg.blog/book.pdf) by James Gallagher 37 | 38 | A free e-book that covers the role of a technical writer, practical guidance for writing technical documents, and working with the rest of your team as a technical writer. 39 | 40 | ## Articles 41 | 42 | ### ['Writing well']((https://www.julian.com/guide/write/intro)) by Julian Shapiro 43 | 44 | A free handbook in five parts that covers what to write about and how to rewrite to be clear and succinct, available online at [julian.com](https://www.julian.com/). 45 | 46 | ### ['How to Write with Style'](http://www.novelr.com/2008/08/16/vonnegut-how-to-write-with-style) by Kurt Vonnegut 47 | Vonnegut presents 8 concise rules. He reminds us to 'sound like ourselves' -- something which is perhaps more difficult but still important in technical writing. 48 | 49 | ### [Material.io's writing guide](https://material.io/design/communication/writing.html) 50 | This aims at language use for user interfaces, but it has many nice rules with concrete, short examples for each. The sections on Tone and Punctuation are applicable to general technical writing. 51 | 52 | ### Essays on CIA writing 53 | This is an interesting, but not that useful, collection of essays about writing well. They are from 1962 and were originally classified, but have since been released. You'll find the usual "avoid the passive voice and jargon" type of advice. The original essays can be found [here](https://www.cia.gov/library/readingroom/docs/CIA-RDP78-00915R001400200001-3.pdf) and a higher level write-up about them [here](https://www.muckrock.com/news/archives/2017/jul/14/cias-style-guide/). 54 | 55 | ### [Writers Stack Exchange, The 'Rules' of Writing](https://writers.stackexchange.com/questions/761/the-rules-of-writing) 56 | A crowd-sourced list of axioms and rules of writing, along with descriptions, thoughts, and examples. You can find the whole list on Stack Exchange. 57 | 58 | ## Blogs 59 | ### [I'd Rather Be Writing](https://idratherbewriting.com/) 60 | A blog written by professional tech writer Tom Johnson on numerous topics including technical communication, processes for managing docs, and information usability. Most well-known for its popular [API documentation course](https://idratherbewriting.com/learnapidoc/). 61 | 62 | ## Websites 63 | ### [indoition](https://www.indoition.com) 64 | Website run by technical writer Marc Achtelig since 2004. Most well-known for its popular [Technical Documentation Tool and Web Guide](https://www.indoition.com/tools-websites-technical-documentation.htm), which lists hundreds of tools useful for technical writing, for its collection of free [AutoHotkey scripts for technical wrters](https://www.indoition.com/en/products/autohotkey-scripts-for-technical-documentation.htm), and for its various [code snippets for improving online documentation](https://www.indoition.com/en/products/code-snippets-for-online-documentation.htm). 65 | 66 | ## Videos 67 | 68 | ### [The Craft of Writing Effectively](https://www.youtube.com/watch?v=vtIzMaLkCaM) by Larry McEnerney 69 | A Youtube video aimed at academics, but very generally applicable writing advice, and why everything you learnt in school is probably wrong. 70 | 71 | ## Style Guides 72 | 73 | ### [Ritza Style Guide](https://styleguide.ritza.co) 74 | Used by [Ritza](https://ritza.co) for technical tutorials and other developer materials. 75 | 76 | ### [The DigitalOcean Style Guide](https://do.co/style) 77 | Used for all tutorials on the DigitalOcean community, this style guide is opinionated but a good starting point for writing tutorials that are widely accessible and engaging. 78 | 79 | ### [Microsoft Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) 80 | Used by technical writers, editors, and content managers working with Microsoft products. You can fork the [repository](https://github.com/MicrosoftDocs/microsoft-style-guide) on GitHub to propose changes through a pull request. 81 | 82 | ### [S1000D](https://users.s1000d.org/Default.aspx) 83 | Used in the Aerospace and Defense industry, S1000D is an international specification for the procurement and production of technical publications. Using XML, this comprehensive styleguide helps to facilitate improved maintenance, logistics, and after-market support. 84 | 85 | ## Courses 86 | 87 | ### Google Technical Writing Courses 88 | A collection of courses for writing clearer technical documentation and improving technical communication skills. The [pre-class material](https://developers.google.com/tech-writing/overview) is a helpful guide. There are also [in-class materials and exercises](https://developers.google.com/tech-writing/for-instructors) available to practice technical writing. 89 | 90 | ### Learn API Technical Writing Course Series by [Peter Gruenbaum](https://www.udemy.com/user/petergruenbaum/) 91 | 92 | A series of three courses for technical writers who want to learn how to write API documentation. They teach how to document structured data, focusing on the two most popular structured data formats: JSON and XML. If you are new to API documentation, this is a great place to start! No programming experience is required, but technical writers with programming experience who want to know more about structured data will still find it useful. 93 | 94 | #### [Learn API Technical Writing: JSON and XML for Writers](https://www.udemy.com/course/api-documentation-1-json-and-xml/) 95 | 96 | #### [Learn API Technical Writing 2: REST for Writers](https://www.udemy.com/course/learn-api-technical-writing-2-rest-for-writers/) 97 | 98 | #### [The Art of API Documentation](https://www.udemy.com/course/the-art-of-api-documentation/) 99 | 100 | ### [Documenting APIs: A guide for technical writers and engineers](https://idratherbewriting.com/learnapidoc/) by [Tom Johnson](https://idratherbewriting.com/learnapidoc/docapis_about_the_author.html) 101 | Course about writing documentation for REST APIs. You’ll learn about endpoints, parameters, data types, authentication, curl, JSON, the command line, Chrome’s Developer Console, JavaScript, and more. You’ll learn about the required sections in API documentation, analyze examples of REST API documentation from various companies, learn how to join an open-source project to get experience, and more. 102 | 103 | ## Meta 104 | *Something as meta as writing about writing would not be complete without a meta section of its own. Here are some articles that already collect and describe other works on writing.* 105 | 106 | ### Good Plain English: The problem with writing manuals 107 | Nat Segnit discusses six books about writing, providing entertaining examples, some focused on contemporary American politics. http://harpers.org/archive/2017/03/good-plain-english/ 108 | --------------------------------------------------------------------------------