Jim Hall has spent the last 30 years at the intersection of open
source technology, and technical writing, contributing to open source projects
since the 1990s. Jim spent most of his career in IT, moving up from Unix
systems administration to IT leadership roles including CIO in higher education
and government.
Jim also has enjoyed writing about IT leadership and technology
since 2010. Jim is the founder of Technically We Write and
Coaching Buttons and has been a regular contributor to Linux
Journal, Opensource.com, Enable Sysadmin,
Enable Architect, Enterprisers Project,
Both.org, and All Things Open where he writes
articles about how things work, including programming, Linux, using the command
line, and other open source and web development tools and applications
My books
Technical Writing for Developers
Learn the basics of technical writing using the developer tools you already know
Explore HTML, Markdown, JavaScript and GitHub and how they can be used for developer docs and marketing copy
Meant as a starting point for tech developers, product managers, marketers and copyeditors
With dev teams evolving, developers and coders are increasingly
tasked with not just the technical elements of their product or project, but
also writing about it. Technical Writing for Developers aims to be a swift 'how
to' guide on utilising HTML, Markdown and other key technologies like
JavaScript and GitHub for document markup and writing, giving quick overviews
on key topics and their practical applications for both developers and
technical writers, especially those who are involved in a ‘Docs as Code’
environment.
We start with a brief overview of technical writing for developers
before jumping straight into core technologies, what they are and where it
could be used, providing several “hands-on” examples to get you started. These
are meant to be concise to give you a taste of each, to give you an idea of
where to get started and how each technology can be applied and utilized in
your product.
You will:
Utilize key web technologies for technical writing
Apply the basic skills required with real-world code examples with sample documents
Apply these skills into your daily projects and routines
This is for: Developers who already know how to use
HTML, JavaScript and Markdown but want to know how to utilize it for writing
documentation, as well as Technical Writers, Content Strategists, Product
Managers and Marketers looking for a quick entry point to key technologies when
it comes to the ‘Docs as Code’ ecosystem.
