Technical writing tools to know
These are the technical writing tools and software that come in handy as a technical writer.
What we're reading
A look back: the Edlin editor
Explore classic editing with Edlin, the original line editor from the DOS era.
Usability testing in open source software
With good usability, everyone will be able to use your software.
Classic word processing with WordPerfect
For years, WordPerfect was the dominant word processor.
What's new
Put a human in the middle of AI
When using any generative AI to create content, you need to put a human in the middle.
Transforming Markdown to other formats with Pandoc
Pandoc makes it easy to convert between a variety of file formats, including Markdown and Word.
Share your story
We invite you to share your story about how you practice what you do.
Exploring generative AI with Ollama
Ollama empowers everyone to experiment with an open source generative AI.
3 cautions about Microsoft Word
Even legacy software can have bugs. Watch for these pitfalls with Microsoft Word.
GNOME usability test for media applications
The GNOME Project shares these usability test results for enhancing user experience across Decibels, Loupe, and Showtime.
How to gain technical writing experience
If you’re looking to earn writing experience, writing about open source software is a great place to start.
My experience of completing a college assignment with Wix.com
I found Wix was powerful yet easy to use for this first-time user.
WordStar for professional writing
Explore why this word processor from the 1990s is a power tool for professional writers.
Technical writing tools to know
These are the technical writing tools and software that come in handy as a technical writer.
A look back: the Edlin editor
Explore classic editing with Edlin, the original line editor from the DOS era.
Website SEO best practices
Learn how to apply good search engine optimization (SEO) practices so your website will be more visible in search results.
Vim color schemes for HTML
I decided to explore what other color themes Vim offered to find one that worked well for me.
Usability testing in open source software
With good usability, everyone will be able to use your software.
Classic word processing with WordPerfect
For years, WordPerfect was the dominant word processor.
How dot matrix printers created text
Learn more about the dot matrix printer with this simulation of a past era.
Slowing down for the summer
We will slow our publication schedule over the summer, but back to our regular schedule in the fall.
Exploring the WordStar file format
As an early entry in word processing, WordStar’s file format is quite simple.
A look back: technical writing with ‘ed’
Technical writers on early computer systems used this simple but powerful editor.
Raising awareness with a press kit
Make it easy for others to learn more about you by creating a press kit.
Wikitext as document markup
Wikis are an excellent way for team members to share documentation with each other.
How to write a great article
Use this guide to write your first article for Technically We Write.
Looking ahead at Technically We Write
We continue to grow our community in technical and professional writing.
Displaying source code in technical documents
Use the Indent command to help you display source code listings in documents.
Understanding Unix ‘nroff’
Explore a simple implementation to understand how this important document preparation system works “under the hood.”
Celebrating our first year at Technically We Write
We started Technically We Write in May 2023 to celebrate technical and professional writing.
Structured writing in Microsoft Word
Let your document structure speak for itself by using Outline View.
Everyone does professional and technical writing
It’s not just technical writers, everyone does some kind of professional and technical writing.
The job's not done until the documentation is complete
Which came first, the program or the documentation? It's both.
Creating a developer documentation workflow
Developers need documentation too. Use a framework to help them write it.
How to transition into technical writing
Technical communication is an exciting career opportunity for everyone.
High academic and low academic
How we write is as important as what we write.
How to write an email
The art of writing a good email is also part of professional writing.
What’s inside a LibreOffice ODT file
All LibreOffice files are zip file containers with XML data and metadata.
Celebrating Global Accessibility Awareness Day
Successful technical and professional communication means ensuring everyone can access it.
Creating accessible Microsoft Word documents
Use these tips to make sure everyone can read what you’ve written.
3 tips to create accessible HTML documents
Create HTML pages and files that everyone can read, regardless of access.
How I format workbooks in LibreOffice Writer
In LibreOffice Writer, using styles makes it easy to keep everything looking consistent.
Distraction-free writing
This is how I get started in my “writing flow” without getting caught in the details.
Share the knowledge
Technically We Write is an open community for anyone who wants to share what they know.
How to publish a book
Tips about publishing your work, for both professional and personal projects.
What is a typographic point?
You’ve probably written enough documents in a word processor that you’ve never really thought about “font size.”
Different keyboard sizes
Explore several different configurations in full-sized and popular compact keyboards.
Collect words and fill paragraphs
All text processors collect words and fill paragraphs, let’s explore what that means.
File management is a power skill
I never thought I’d have to know about folders, but I do.
3 ways I provide peer editing
These are the most common types of editing I do for my colleagues.
How visual brand affects user experience
You don’t need the full graphical elements to recognize a familiar environment.
Usability themes in software design
Explore these themes about how users interact with software interfaces.
Font pairings for print
Use this handy guide to pair the right heading font and body font to suit your next print project.
How to change fonts in ‘groff’
You don’t have to use the default Times font to print documents. Load new fonts to make your document look great.
Ways to test usability
There is no “one true way” to perform a usability test.
What is usability testing
Usability testing means that real people can do real work in a reasonable amount of time.
Understanding ‘fmt’: the trivial document formatter
The ‘fmt’ command is a useful utility to format text files so lines are the same length.
The art of writing scenario tasks
A good scenario task sets a brief context then asks the tester to do something specific.
How to test usability
There is no usability test that is "one size fits all." Two popular methods are the paper prototype test and the lab usability test.
Creating website mockups with placeholder text
Creating design mockups is easy with this web font for placeholder text.
How I teach usability
I prefer a hands-on practical approach to teaching usability testing.
Writing is about curiosity
My passion for technical and professional writing is about exploring new topics and writing about them.
Why ‘carriage return’ and ‘line feed’?
Explore a bit of history to learn why we still use these terms to refer to the end of a line in a text file.
Comparing my favorite fonts
The font you use in your documents can provide a classic feel or evoke a more modern approach. Here are a few favorites.
The real difference between that and which
"That" and "which" are imprecise words by design. They're convenience terms to help ideas flow smoothly through efficient English.
Remixing content with DITA Maps
Reuse and remix content to create new documents using DITA Concepts and DITA Maps.
Getting started with DITA OT
DITA is a powerful technical writing technology that makes it easier to reuse content in new ways.
How I wrote academic papers in groff -me
Learn simple macros to add footnotes, blockquotes, lists, subheads, and other formatting for your academic papers.
Make websites more readable with a Bash script
Calculate the contrast ratio between your website's text and background to make sure your site is easy to read.
Converting Simplified Docbook to PDF
Convert Simplified Docbook files to PDF using pandoc and LibreOffice with this Bash script.
How and why I write articles
Share what you know by writing about it, including all the mistakes and problems, to help others through the same issues.
What is a content strategist?
Content strategists work with subject matter experts or technical practitioners within a company to create compelling content.
3 image tools I use for technical writing
Including a diagram, chart, or other image can make your writing more clear.
A step-by-step guide to adding a map in Drupal
Let this article walk you through the steps to create a map on a Drupal website using the Simple Google Maps module, and review other mapping modules in Drupal.
Hands-on experience in technical writing
With practice, we get better at writing. Tips and ideas to get started as a technical writer.
Write in modules
Consider your medium and your workflow, and use the concept of modular documentation.
Open source technologies we’re excited about
Using open source tools and open technologies makes it possible for anyone to practice technical writing.
Technical writing in open source software
Google's Season of Docs is a grant program to help open source software projects improve their documentation.
Using LibreOffice from the command line
Leverage these powerful command line options to get the most out of LibreOffice Writer.
Why I write about open source software
We interviewed one writer to learn their story about how they got started writing about open source software.
The art of great copywriting
Copywriting is a niche within content writing. We asked a copywriter to share her tips on great copywriting.
How to write about open source software
Thanks to the Both.org editors for this interview to help new writers get started writing about open source software.
How to write your first article
We want to share your story! Here are a few ways to write your first article with us.
What is a wiki?
Wikis provide a space to collaborate on documentation, one piece at a time.
Technical editing in a community
Thanks to Seth for sharing his insights about technical editing for a new community website about open source.
Digging into tagged PDFs
PDF provides an excellent way to capture print-like output for online viewing. Tagged PDF is the format that specifies marked content.
A new community for open source writers
Both.org is an excellent resource for learning about Linux, programming, and open source software.
How I write books about Linux
Read about how one author writes his books about Linux and systems administration.
8 tips for pitching articles to editors
Pitching article ideas to publishers is critical to a successful writing business.
Teaching technical writing with open source
With the writing tools and technologies that we learn in this course, students are very well prepared for careers in technical writing.
Technical writing and technical editing
Technical writing is more than just words, and technical editing is more than just spelling and grammar.
Passive voice can be used by you
You don't have to completely eliminate passive voice in your writing. Use passive voice to shift focus to what's most important.
The importance of semantics
It's important to keep semantics in mind for your technical writing, to help users and systems interpret meaning.
A great device for technical writing
Start here to set up a great system for technical writing, using Linux and open source software.
Print-ready files in Scribus
Add desktop publishing to your personal toolkit with this introduction to print-ready files using Scribus.
My four favorite writing tools as a freelancer
These are the tools one freelance writer uses all the time. Plus a bonus tool!
Our first year at Technically We Write
Join us by sharing an article on your favorite topic. Contact our editors to share your article ideas.
Your favorite articles about groff in 2023
Learn about everyone's favorite Unix text formatter and document preparation system in these how-to articles and interviews.
Your favorite DITA how-to articles
We shared many articles in 2023 about how to get started with DITA topic authoring. Here are seven DITA articles that our readers found most fascinating.
Your favorite technical writing round-ups
Technically We Write is a community - and we like to celebrate our community by highlighting their stories in "round-up" articles. These were your favorite articles this year.
Our favorite HTML how-to articles
Start with these four great articles if you want to get started writing documentation in HTML.
Our favorite articles about usability testing
Anyone can do usability testing. Read these great resources if you want to learn how to get started with your first usability test.
4 retro tools I use in technical writing
Sometimes, an older tool is the right tool. Here are four retro tools I use all the time in technical writing.
Learn LaTeX from these top articles of 2023
If you want to learn how to write with the LaTeX document preparation system, don't miss these popular articles from 2023.
Learn concepts, they'll teach the tools
Don't worry about learning the "wrong" tool. Learn the concepts and those skills will transfer to other, similar tools.
A look back: Your favorite classic word processors
Over the last year, we've taken a look back at some of these venerable word processors. These are your favorites.
Add map-making to your technical writing skills
Information design elements can make information more clear to your readers. Here's how to add maps to technical documents.
Your favorite articles about document markup
We shared many articles this year about document markup systems. These are five articles that were popular with our readers.
Our favorite power tips for using Drupal
Several writers shared their advice for how to use Drupal effectively. These are the articles our community found most engaging.
Favorite tips for using word processors
Many writers rely on a desktop word processor as their standby for creating documents quickly.
Top interviews of 2023
We love sharing interviews with technical writers. Here are the top interviews that you enjoyed reading this year.
What's your technical writing story?
We want to share your story about how you got started on your technical communication journey.
How I teach: Writing with Digital Technologies
My focus in teaching "Writing with Digital Technologies" is to prepare students for successful careers in technical communication.
Gift suggestions for your home office
Our community shares these gift ideas to make your home office more comfortable.
Your favorite devices for writing
Our community shares their favorite keyboards and other devices to make writing easier and more fun.
Your gift buying guide for writers
Our community shares their favorite gift ideas that every writer will love.
A look back: MacWrite
Relive early word processing using this classic word processor on the original Macintosh.
Thanks for a great community
Celebrate our community by reading these great articles and interviews and articles from our first six months.
Configuring roles and permissions in Drupal
Take a tour of configuring user roles and permissions in Drupal both with the core options and with the help of some useful contributed modules.
Exploring automated translation
Automated translation tools can often do a "good enough" job of translating between languages, with some differences.
Crafting a FAQ page on a Drupal website
How to create a FAQ page using the Drupal core, and other capabilities provided by some contributed modules.
Writing for social impact
Writing a book is a big task. Nate shares his process to write and edit his book, from start to finish.
Gift idea roundup
What are your recommendations for this year's holiday season? Share your ideas and we'll include them in an upcoming community roundup.
It's World Usability Day
Here are several methods you can use to understand what works and what to improve in your project.
My plagiarism story
This unfortunate classroom experience delivered a memorable lesson to cite your sources. Professionals should do the same.
Linux like original Unix
Enjoy this look back at what it was like to create technical documents on Unix from 50 years ago.
International professional communication
Technical communicators need to work effectively across cultures and languages.
How to be a great copywriter
Copywriting sells products and services by inspiring an audience to take action. We asked one copywriter what that is like.
An introduction to groff -mom
Mom is an excellent and flexible macro system, capable of generating a variety of different output types including books, articles, and memos.
Writing in teams
Collaborating effectively is a key skill in any career, especially technical communication. Learn how to write together more effectively.
We want to interview you
We want to interview you about your technical or professional writing. Let us share your story.
Writing a simple text formatter (part 2)
A further demonstration of how document preparation works behind the scenes, with a program to fill a paragraph with text.
Writing a simple text formatter
Let's explore how document processing works by creating a simple version of a text formatting system.
My technical writing story: I love writing
My interests in communication, language, and culture are a perfect fit in technical communication.
How to write with Docbook
Docbook is an excellent markup system schema that technical writers can use to create all kinds of documents.
Learning how to use groff -mom
Mom is a new groff macro package that makes it easy to create different kinds of documents.
Git for writing documentation
Technical writers can use Git to collaborate on documentation, such as for open source software projects. These are the basics.
Technical writing roundtable
We gathered a panel of writers and editors to discuss topics in technical writing.
What recommendations for a first-time writer?
Our community shares their advice for anyone who's just getting started in technical writing.
What tool do you use most of the time?
Our community shares what is their favorite word processor or other writing tool.
Technical writing history with ed and nroff
Enjoy this practical demonstration of technical writing history on old-style Unix.
How did you get into technical writing?
Read about how our community got interested in technical and professional writing.
Where did you write your first article?
We asked our community about the first article they remember writing and where they published it.
Writing books in groff
I interviewed a technical writing author who uses groff to write his books.
Adding a full-width byline in Word
Word on the Web doesn't support full-width bylines, but you can get the same effect with a 2-column, 1-row table.
Submission style guide
When you submit an article, we'll help edit for grammar, spelling, and style.
Multi-column layout in Word
Follow these steps in Microsoft Word on the Desktop to format a document with a two-column layout.
Share your love of writing
Share a paragraph to answer these prompts. We'll include them in our roundup articles next week.
Images in Microsoft Word
Images are a great way to make a document easier to read. Here's how to add images to Microsoft Word documents.
XML as a document markup language
Due to its extensible nature, you can define your own XML tags to create a custom document markup language.
XML as images
When writing for the web, an excellent diagram format is a Scalar Vector Graphic, or SVG.
XML as data
XML can be used to describe any kind of data. Let's see how to assemble an XML file:
A look back: Dot matrix printers
By printing an arrangement of dots next to each other, the dot matrix printer could produce letters.
Explore web topics with an article
If you would like to write an article for Technically We Write, but aren't sure where to start, start with this list of suggestions.
Modern groff macros with -mom
The -mom macros provide a modern way to write technical documentation in groff. Learn more in this interview with its developer.
Page headers and footers in Word
Adding a page header and footer can turn a simple document into a more formal one.
Serif on paper and sans-serif on screen?
The old rule "serif on paper and sans-serif on screen" no longer holds true with modern displays.
Paragraph spacing in Microsoft Word
Create professional-looking business correspondence with a few clicks to set spacing before and above paragraphs.
Consider your fonts
A sans-serif font can project modern and new, while a serif font often suggests tradition and formality.
Looking ahead to National Day on Writing
This year, Technically We Write plans to mark the National Day on Writing with a week-long set of articles and roundups about writing.
A look back: printing documentation on the Model 33
Explore computing history with this sample program to print one page at a time to a Model 33 terminal.
Groff by example: tables with tbl
Use this sample groff document to learn how to format tables that span data between rows and columns.
Career options: Technical writing
Let's explore this career area in technical communication with a typical job description.
Styles in Microsoft Word
A power feature in any desktop word processor is styles. Learn how to use paragraph and character styles in Microsoft Word documents.
Writing with digital technologies
Our community shares their advice for what digital writing technologies students should know how to use.
What is a technical description
Technical descriptions are used everywhere, in every field, to describe things and processes.
A look back: early word processors
These programs sported features that were new at the time, but common today.
Ethics in technical writing
Every career field has a code of ethics or code of conduct for their specific area. And we're defining our own code of conduct for this website.
How to use OTF, TTF or PFB fonts in groff
You can add other fonts for use in groff. Use this script to convert TTF, OTF or Type1 fonts for use with groff documents.
Our favorite technical writing tools
We asked our community to recommend a technical writing tool that students should learn how to use.
DITA projects in Oxygen XML Editor
DITA is a power tool for technical writers who need to reuse content. Explore one popular DITA tool: Oxygen XML Editor.
Google Bard as an AI co-author
Bard is quickly proving itself as a capable generative AI tool. Two examples of using Bard for technical writing.
The skills technical writers rely on
What's one skill that students should know as they enter the workforce? We asked our community for their advice.
Advertising statement
Technically We Write does not sell advertising on the website.
Learning about DITA
Technical writers can use DITA to break up a project into topics. Learn more about DITA in this interview with a DITA expert.
Building the -me macros
Learn about the history of the troff -me macro package to prepare technical papers.
A look back: The Teletype Model 33
This milestone in computing history is an excellent look back at how technical writers created documentation in an era before the desktop word processor.
How do you teach technical writing?
If you teach technical writing, we encourage you to write about it. A few ideas to share your first article.
Leveraging AI in Drupal websites
Generative text AI like ChatGPT can boost productivity. Explore ways that you can use AI in creating content for Drupal sites.
"Back to school" round-up
Share your advice for students headed back to classes this September. What advice would you share?
Managing Menus in Drupal 10
Discover the basics of menu management and some contributed Drupal 10 modules for menus.
AI for technical writing
More technical writers use AI to help them in their daily work. It's time to embrace AI as a technical writing tool.
Authors and ChatGPT
Technically We Write is a community of people, and that's a core value of everything we publish on the website.
Use Technically We Write in the classroom
Instructors are welcome to share our content with their classes as a useful resource in technical writing.
Students are welcome too!
Technically We Write isn't just for technical writers; anyone is welcome to join the community. Here's how students can contribute an article.
Content Editing Experiences with CKEditor 5 in Drupal
Explore some of the great new features you can use right now in CKEditor 5 and Drupal.
Mastering Markdown with MarkText
MarkText is a text editor that aims to make writing Markdown files easier.
Finding the right "voice" for technical writing
Technical and professional writers need to aim for a middle ground that balances readability with formality.
Image Lazy-loading in Drupal
Improve your website's responsiveness with image lazy-loading. Here are three ways to use lazy-loading on Drupal.
Celebrating leadership with a new community
Follow our new sister website, Coaching Buttons, for an open community about leadership.
Code samples with GNU groff
Once you know how to turn off text "fill" and set the font, you can include code samples anywhere in your groff documents.
Why and How to Add a Live Chat to Drupal
Live chat can improve your website's customer experience and increase sales. Learn how to add the LiveChat module in Drupal to your website.
Putting it all together with DITA Maps
Connect multiple DITA topics together using DITA Map to create different kinds of documents - all without copy/paste.
Lessons from launching a website
If you're planning to launch your own article-based website, you may find these lessons useful.
Boost SEO with URL Redirects in Drupal
Make content easy to find on your Drupal hosted website by using the Redirect module.
DITA by example: Reference files
DITA Reference files provide "just the facts" about a product. Use this sample DITA Reference file as a guide in learning DITA.
A look back: Galaxy word processor
Explore how to create technical documents using this shareware DOS word processor.
Tables with groff tbl
Using the tbl pre-processor with groff, you can create sophisticated tables with a variety of styles.
Markup is not just HTML
Technical writers need to be familiar with a variety of markup tools. Here's a rundown of three popular markup systems.
Just the facts: DITA References in Oxygen
If you need to capture plain data about something, use a DITA Reference file. Here's how to create a DITA Reference in Oxygen XML Editor.
How To Schedule Content For Future Publishing In Drupal
Learn how to schedule new content to go live on your website at a future date, using the Scheduler module in Drupal.
Grammar for technical writers
Let's review common elements of grammar as they relate to technical writing.
Using ChatGPT content assistance with Drupal
Explore three ways the ChatGPT Content Assistance module can enhance your website using generative text.
A mystery of document preparation
Dennis Ritchie's PhD thesis is a masterpiece of typography from a time when computer document preparation was in its infancy.
Watch: DOS ebooks with AMB
Watch this video to learn how to write ebooks using AMB, the Ancient Machine Book format.
DITA by example: Task files
DITA Tasks describe a process. Use this sample DITA Task file to demonstrate the most common features you need in a Task file.
ChatGPT Integration with Drupal websites
ChatGPT can generate useful and interesting text to help your users. Here are a few ways to integrate ChatGPT with websites hosted in Drupal.
The structure of a how-to article
Writing a how-to article doesn't need to be a daunting writing assignment. Follow these steps to write your first how-to article.
DITA Task files in Oxygen
DITA Task files describe the steps to complete a task. Learn how to create DITA Tasks using the Oxygen XML Editor.
ChatGPT is an okay technical writer
ChatGPT can help streamline work by automating more mundane writing assignments. However, approach carefully.
A brief history of RUNOFF
RUNOFF was an early significant milestone in technical writing, using the computer to process text. I interviewed Jerry Saltzer about his work on RUNOFF.
LaTeX by example: tables
Sometimes, technical information can best be represented by a table rather than in words. Use this sample document as a guide for creating tables in LaTeX.
Modern troff with GNU groff
One developer's involvement in GNU groff, the small but powerful document preparation system.
DITA by example: Concept files
Concept files are one example of DITA topics. Explore DITA Concept files with this sample document.
Bring clarity with these document design tips
To help your reader find the most important information in a document, apply document design. A few key tips for your next project.
GNU groff: Powerful document formatting in a small package
Learn about groff's history and development in this interview with one of its developers.
Why technical communication
What motivates you to work in the technical communication field?
A look back: WordPerfect on DOS
For years, WordPerfect was the dominant word processor. Take a step back in time with this history and visual tour.
How to check spelling on old school Unix
How did technical writers check spelling on original Unix systems? Let's learn how to make our own tools to spell check documents.
Use this to make placeholder text more fun
There's more to placeholder text than the standard "Lorem ipsum." Placeholder text doesn't need to be boring.
How we share documents
How do you collaborate on documents? We asked our community how they work together.
Analyzing usability tests with heat maps
How do you report the results of a usability test? Here's a visual way to share results.
Sample documents with Lorem Ipsum
Leverage this common placeholder text to generate filler text for documents, websites, and other sample material.
The art of the scenario task
Scenario tasks are the backbone of a successful usability test. Follow these best practices for writing your next scenario tasks.
LaTeX by example: code listings
Learn how to use the listings package to add formatted code samples to your LaTeX documents.
Check spelling on Linux with this cool script
Take a look back at Unix history with these old school commands to check spelling in a document.
How to write your first article at Technically We Write
Interested in writing an article? Here's how to get started.
How we work as a team
What tools do you use for team collaboration? We asked our community to share their process.
Writing great user stories
Use scenarios are an important part of usability test design. When writing your own use scenarios, remember these best practices.
Markup with Markdown
Most of Markdown borrows existing conventions from writing in plain text. Explore some advanced formatting you can create in Markdown.
What's new and cool in Drupal 10.1
Drupal 10.1 comes packed with new exciting features for site builders, developers, and content editors. Let’s review what’s new in the release.
Groff by example: equations with eqn
Use this sample document as a quick start guide to writing scientific documents in groff and eqn.
A look back: Unix from 50 years ago
We've come a long way in technical writing. If you'd like to see how technical writers did their work in the 1970s, watch this video.
DITA Concept files in Oxygen
DITA Concept files are an excellent way to capture definitions and descriptions. Use this as a quick-start guide to create DITA Concepts using Oxygen.
Using AI as a co-author?
How has generative AI changed your work? Here's what our community has to say.
How many usability testers
How many testers do you need to get actionable results? The answer is "about five." Here's why.
AMB: Ancient Machine Book
Writing with digital technologies can include a variety of tools. Here's how to start writing in a lightweight ebook format.
Introduction to Markdown
Markdown makes it easy to convert text by borrowing conventions for writing plain text documentation.
A look back: Microsoft Word for DOS 5.5
While over 30 years old, this DOS word processor still feels very modern in a "retro" way.
Blast from the past: Our favorite classic word processors
Computer based word processing goes back as far as the personal computer. What was your favorite word processor from the past?
How to write usability testing personas
Personas help us understand who uses the system, and why they use it. Use these quick tips to write your first personas.
4 popular word processors
Technical writers often rely on a word processor to do much of their work. Compare the pros and cons of 4 popular word processors.
Quick start guide to usability testing
Let's examine the steps for a popular usability test method: the formal usability test.
LaTeX by example: equations
Need help writing scientific and engineering documents with LaTeX? Use this sample document as a reference for equations and mathematics.
Our favorite word processors
Word processors are a longtime favorite of technical writers. We asked our community about their top picks.
Nroff by example: Manual pages
If you work on Linux-based projects, you may need to write "man" documentation suitable for Unix systems. Use this file as a template to write your next "man" page.
How do you edit plain text?
We asked our community to share what text editors they use for plain text. Is your favorite on the list?
How to write great documentation
Recently I attended a conversation about tips to create great documentation. Here are 4 top themes from that discussion.
Learning about usability
How do you define good usability of an information product? And you don't have to be an expert to run a usability test.
I wrote a book using ChatGPT
This was an interesting experiment that pushed ChatGPT to its limits as a co-author tool.
Write for those who read it
Don't worry about writing for everyone. Instead, focus on those who want to read what you write.
What is a User Experience Designer?
User experience design is making new ideas visible to the team so people can discuss or test key concepts.
What's your favorite font?
What's your favorite font for print? We asked our community to share their favorite picks.
Watch: How to write documents with groff -me
Watch this video if you want to learn how to write documents with groff -me on Linux.
Why Universal Design
Accessible design should be embraced as a philosophy in technical communication. Three takeaways to build accessibility into your next project.
Use your tools, but write like you
Automated tools help us in our writing, but don't let tools replace the "you" in what and how you write.
An introduction to LibreOffice
LibreOffice is a professional open source desktop office suite used by technical writers around the world for all kinds of projects, large and small.
Getting started with web accessibility
Build accessibility into your projects to ensure everyone can access it. Start with alt text.
It's better to be clear than correct
English writing has a lot of rules, but good technical writers know when to follow them and when to break them. Here are a few examples of when it's better to be clear than correct.
LaTeX by example
Looking for a quick start guide to writing documents with LaTeX? Use this sample file as a template for your next technical documentation project.
Our favorite keyboards
Choosing a keyboard is a very personal decision. Here are some of our favorite keyboards.
Footnotes and asides are a warning
Keep the focus on your main points and avoid distractions like footnotes. A few tips to refocus your writing.
Technical writing as a passion project
Find your passion and write about it. Don Watkins shares his experience as a technical writer about Linux and open source software.
Stop writing like an engineer
Technical writing can be a difficult task if you don't have much practice with it. Tips to improve your technical writing.
Steps of an algorithm
Steps provide clear guidance on what to do and when to do it, but there are some nuances to consider when using steps as an author.
DITA topics with Oxygen XML Editor
DITA makes topic based authoring easier. Create your first DITA topic using Oxygen XML Editor.
A look back: WordStar 4.0 for DOS
WordStar was a popular word processor in the early DOS era. Let's take a look back at this classic word processor.
Your journey in technical writing
A discussion about technical writing and Drupal with AmyJune Hineline.
Are you using examples correctly in your technical writing?
Here are 5 things about examples you should consider when writing documentation.
My role as an editor
One perspective on the "technical editor" role. Five things I do as editor for Technically We Write.
Manage DITA projects in Oxygen XML Editor
Managing a DITA project? Oxygen XML Editor is a flexible cross-platform DITA editor that makes it easy to work on projects.
Solving the copy/paste problem with DITA topics
Avoid copy/paste between documents by moving your workflow to DITA topic based authoring. Three tips to get started.
About technical and professional writing
Chris Hermansen describes his journey as a technical and professional writer. Thanks to Chris for this great interview.
Nroff by example: The basics
The first popular markup language was nroff, which formatted text for typewriter-like devices. Let's learn the basics of formatting text in the original nroff.
GitHub for technical writers
Many organizations rely on GitHub or other repository systems to manage projects. Here are 3 tips to manage documentation in GitHub.
Perspectives on technical writing
Thanks to Seth Kenlon for this great interview about technical writing.
Technical writing with GNU groff
On modern systems, nroff and troff are combined as GNU groff. Read about their fascinating history and what you can do with these original Unix tools.
Tables and data structure
Technical writers don't always have to rely on tables for information. With a new approach, you can structure information in a new way.
Getting started with LaTeX
The LaTeX document preparation system is a popular markup language for scientific and engineering documents. Learn to write your first document.
What's inside an EPUB file
Electronic books as EPUB files can be a great way to publish content across a variety of platforms. Learn what's inside.
How to contribute to Technically We Write
We welcome everyone to share their story on Technically We Write. Here are a few suggestions for your first article.
Write dynamic web documentation with javascript
With a little javascript, you can create documentation that adjusts to your reader's preferences.
How to use LibreOffice Writer templates
Writing documentation is always easier if you can use a template. Get started with LibreOffice Writer document templates.
5 things you didn't know about styles in your word processor
Styles are a power feature in technical writing. Learn five ways you can leverage styles to work for you.
Write HTML documentation with style
HTML makes it easy to publish content on the web. CSS makes it easy to style your content to make it look the way you want.
Make writing easier with speech recognition
Tired of typing? Try speech recognition with this open source tool.
Add margin notes to your next book project
With margin notes, you can provide notes for your reader, such as extra context, errata, or pointers to other material.
Retrospective: Text processing on Unix with pr
Unix has always excelled at processing text. Here's a look back at the pr command to prepare documents for printing.
Writing technical documents in HTML
Learn to use basic HTML tags like bold and italics to format your documentation.
How to make screenshots on Linux
Save time by taking screenshots on Linux with one of my favorite tools.
A gentle introduction to HTML
Learn the basics of block and inline styles in hypertext documents.
A look inside: ODT files
You can use standard tools to examine an OpenDocument Text word processing file and extract data from inside it.
A look back: Technical writing with nroff and troff
Take a trip back in time to experience technical writing with nroff and troff from the original Unix system.
Stay focused with LibreOffice keyboard shortcuts
Here's how I use the keyboard shortcuts in LibreOffice Writer so I can focus on the content that I'm writing.
Reformat text on the command line
Here's how I use fmt to reformat text to write plain text files or to quote text.
Write with us
Everyone is welcome to contribute to Technically We Write. We'd love to share your story.
Advertising on Technically We Write
Technically We Write does not sell advertising on the website.
About us
Technically We Write is about technical writing, technical editing, and all things "technical communication." Learn more about who we are.