The social network for technical communicators

Welcome

TWW is an open and free community for technical communicators. After signing up, create a blog, start a discussion, add an event, and invite your friends!

Please take a moment to read some getting started tips and posting guidelines.

Members

Don't Be Blue

Blog Posts

How Atlassian uses K15t Software Scroll Content Management Tools

Posted by Nils Bier on September 16, 2014 at 8:51am 0 Comments

Hi everybody,



I’m working for K15t Software GmbH, we are specialized on developing content management add-ons for the collaboration platform…

Continue

MSWord getting familiar among writers

Posted by Shinha on July 17, 2014 at 6:50am 1 Comment

Microsoft Word is common and flexible for editing the documents compare with other tools. Created a document by using other technical tools, that makes complicated to non-technical folks while editing. They are not…

Continue

Urgent opening for Technical Writer

Posted by Nibha Kuttappan on July 9, 2014 at 10:24am 0 Comments

Hi,

We have an urgent opening for Technical Writer at our company C-Sam Solutions Pvt. Ltd. (A MasterCard Company), Vadodara, Gujarat.

Interested candidate plz mail me their resume to : [email protected]

Active Shooter, Bomb Threat, or Just Rumor

Posted by Bruce Curley on June 7, 2014 at 2:12pm 0 Comments

There’s an active shooter at South Carroll High School!!! God, I hope Eamon is safe! What can we do!!?”

That is what I heard through my wife’s sobbing when I picked up…
Continue

Creating web-help systems with Joomla!

Posted by Matt Majeske on June 4, 2014 at 10:32am 13 Comments

A few years ago, I posted an explanation of how I used Joomla as a publishing platform for technical documentation on a corporate intranet. I continue using Joomla today, but in a different context: now I use it as a web-help…

Continue

How To Become An Effective Technical Writer

Posted by Dennis Redley on May 8, 2014 at 12:30am 0 Comments

The practice of technical writing is very different from creative writing,…

Continue

Need Guidance

Posted by Bala Murugan on February 1, 2014 at 9:10am 1 Comment

Hi all, i had read your comment. Now am working as a technical research writer for Writerbay. I am holding a technical degree in Electrical and Electronic Engineering, and i has planned to switch company. can any one guide me about companies need…

Continue

Microsoft Word as technical writing tool

Posted by Vishnu Swami on January 25, 2014 at 9:30pm 0 Comments

I still see lots of teams using Microsoft Word for technical documentation. This makes me wonder why companies cannot find tools other than Microsoft Word.

What's your take?

web hosting writiters

Posted by Nataly Kalian on December 28, 2013 at 2:16am 3 Comments

We need professional writers. Language – English. Topic – Web Hosting.  4000 characters without space, need informative articles on webhosting.  You do the task if it is good enough we pay. No milestone. Payment presently via PayPal, Webmoney and…

Continue

Spread the Word


TWW has 2000 members.
Tell your friends about us!

Did You Know?

Technical Writing World averages 100,000 pages views from over 14,000 unique visitors per month, excluding bots and crawlers. Consider becoming a sponsor.

Visit our Fan Page

Did You Know?

If you have a blog outside of TWW, you can promote it here. In the left column of your profile page, click Add RSS.

 

Techcomm on a Map is here!

Brought to you by Sarah Maddox - thank you, Sarah! Try it now.

Latest Activity

Daniel Berman is now friends with Anton Bychkov and Rahul lakshmanan
5 hours ago
Chrisman Wilkey is now a member of Technical Writing World
10 hours ago
Kai Weber replied to Jun Shoji's discussion When do I need to add "the" preceding to a product name?
"I think a good way to proceed is: Ask the trademark holder. If you cannot ask or don't get an answer, consult the trademark holder's style guide. For Apple, that style guide is at…"
23 hours ago
Rahul lakshmanan left a comment for Christine Kim
"I am an enthusiastic and dedicated person who is flexible and believes in team spirit, with a passion for knowledge, having a foundation and a keen sense of interpersonal relations; I believe I have what it takes to excel in the present professional…"
23 hours ago
Rahul lakshmanan left a comment for Anna Irwin-Schutze
"hello Anna ; Are you technical author for aerospace or mechanical?"
23 hours ago
Jun Shoji replied to Jun Shoji's discussion When do I need to add "the" preceding to a product name?
"Thank you so much, Kai. So that means, adding an article to an apple product while it does not have one on the apple website is wrong, is my understanding correct?"
yesterday
Melanie Blank replied to Bianca Alexander's discussion Mgr has unrealistic expectations. Don't want to lose my job. Advice please!
"William - I disagree with some of your comments, but I like others. I have been a technical documentation consultant or contractor for over 20 years.  Even if a contractor is expected to "hit the ground running," the contractor still…"
yesterday
Profile IconMelt Strydom, Alison Kendrick and Rahul lakshmanan joined Technical Writing World
Saturday
Alison Kendrick posted a discussion

Hyperlinked Documentation - How often?

Hi,I am a technical writer in a municipal government setting. I have been writing a number of business processes, some of which contain hyperlinks to other documents (forms, manuals, etc.). The way my document is set up is that I provide a process…See More
Friday
Kai Weber replied to Jun Shoji's discussion When do I need to add "the" preceding to a product name?
"There is no set rule that applies to all product names. Instead, it's up to each company (or their marketing department) to decide whether they want the article or rule it out. Your best bet is to ask whoever holds the trademark for the product…"
Friday
Rick Fox replied to Rick Fox's discussion Creating Repeating Content without a CMS
"Thanks, but maybe I wasn't clear enough. My company will not invest in another app. We use MSWord for standalone docs and RoboHelp for our online help system. I just wanted to get a feel for what other TWs are doing. Do you refer users between…"
Friday
Jun Shoji posted a discussion

When do I need to add "the" preceding to a product name?

Hello,I am wondering what is the rule for whether or not to give definitive article "the" preceding to a product name. I am having a hard time understanding this, b/c it seems random.For instance, if I google "Mac Book Pro", some article including…See More
Friday
Profile IconChristie Pena, Rick Fox and Jansi joined Technical Writing World
Thursday
Kai Weber replied to Rick Fox's discussion Creating Repeating Content without a CMS
"Hi, Rick, one solution that gives you a lot of bang for the buck without the cost or hassle of installiing a CMS is MadCap Flare. It imports fairly easily from Word and does what you need. See their blog post at…"
Thursday
Rick Fox updated their profile
Thursday
Rick Fox posted a discussion

Creating Repeating Content without a CMS

My company does not use a CMS and is not planning on acquiring one in the future. Plus, most of our documentation is produced in MSWord, which doesn't help much.My problem is repeating content in multiple docs. My challenge is to repeat content as…See More
Thursday
Patsan Eugeniya and Jason Crockford are now friends
Thursday
Shinha liked Lynette Delane's discussion Documenting Customer Induced Delays
Thursday
Sheikh Nasir Subhani and Pierre Delaunay are now friends
Sep 17
Jacky is now a member of Technical Writing World
Sep 16

The new and improved Techcomm Superfeed is here!

The latest posts from the top techcomm blogs all on one page. Dynamic, interactive, and engaging. Read more or try it now.

Did You Know?

You can easily connect your accounts on social networks such as Twitter, Facebook, and LinkedIn to your account here. You can then sign in with a single click, and share interesting content with your friends on other networks.

Click Settings, then Connections.

Forum

When do I need to add "the" preceding to a product name?

Started by Jun Shoji in Questions, Opinions, and Thoughts. Last reply by Kai Weber 23 hours ago. 3 Replies

Hello,I am wondering what is the rule for whether or not to give definitive article "the" preceding to a product name. I am having a hard time understanding this, b/c it seems random.For instance, if I google "Mac Book Pro", some article including the Apple's don't use "the", but some do.I am writing some product description, so I need to understand this...Thank you very much for your help!Continue

Tags: proper, noun, name, product, tech-writing

Mgr has unrealistic expectations. Don't want to lose my job. Advice please!

Started by Bianca Alexander in Questions, Opinions, and Thoughts. Last reply by Melanie Blank yesterday. 8 Replies

Hello Everyone,I have about 5 yrs experience as a tech writer/editor in the oil & gas industry. Up until last week, I had been unemployed for 8 mths after having been laid off. I'm currently doing contract to possible perm work at an engineering firm that services the oil and gas industry. Today was my 5th day on the job.My manager's expectations are totally unrealistic. Last Friday we discussed the work I'd complete this week. I understood that I would create web content for 5 of their…Continue

Hyperlinked Documentation - How often?

Started by Alison Kendrick in Questions, Opinions, and Thoughts on Friday. 0 Replies

Hi,I am a technical writer in a municipal government setting. I have been writing a number of business processes, some of which contain hyperlinks to other documents (forms, manuals, etc.). The way my document is set up is that I provide a process overview and then a table which lists the process steps.My question is about whether I should hyperlink the references to the other documents both in the process overview and in the process steps, or just the steps. Also, how many times is it…Continue

Creating Repeating Content without a CMS

Started by Rick Fox in Software and Stuff. Last reply by Rick Fox on Friday. 2 Replies

My company does not use a CMS and is not planning on acquiring one in the future. Plus, most of our documentation is produced in MSWord, which doesn't help much.My problem is repeating content in multiple docs. My challenge is to repeat content as little as possible to avoid multiple corrections/updates to the same content in different docs. To do this, I find myself referring readers to other documents quite often, sometimes referencing multiple documents from within the same section. Plus,…Continue

Tech Writing on digital/bit electronics?

Started by Kevin Self in Software and Stuff. Last reply by Kevin Self Sep 16. 2 Replies

Anybody out there who does technical writing about electronics on a digital/bit level? I'm write computer chip manuals and I can't find any standards for specific and boring stuff that I write about every day. Questions like which is preferred?“set bit to 1″, or“set bit to logic 1″, or“set bit to logic one”, or"set bit = 1", or“set bit high”, orjust “set bit”, ?or“These bits select the sink current ”, or“These bits configure the sink current” or "These bits set the sink current"I am not asking…Continue

When to make multi-word function/app names without spaces?

Started by Jun Shoji in Software and Stuff. Last reply by Jun Shoji Sep 15. 2 Replies

Hello, sorry for the entry-level question.I am trying to understand when and why manufacturers sometimes make name of functions/apps of their product multi-word without spaces? It seems grammatically irregular, but I find this case quite often. What is their intention to make names like that? e.g. FaceTime (apple), GarageBand (apple), DataMan (cognex), etc. Please also let me know good websites to refer to this kind of tech-writing tips if you know of any so that I don't need to bother you…Continue

Tags: format, interface

Use or not use em-dash when it is displayed separately such as: ---

Started by Jun Shoji in Questions, Opinions, and Thoughts Sep 15. 0 Replies

I would like to use an em dash in a marketing copy in a marketing material of some new product from my company.There is a sentence which seems to be a case that em-dash grammatically fits, but when I type hyphen three times Power Point simply displays three separate dashes.Does three-hyphen still function as an em-dash?Sorry I am not used to this kind of writing... need help.I am trying to use the em dash as in the following way: - "The new XX (product name) enables a simple 3-step setting---no…Continue

Tags: hyphen, dash, punctuation, rule, grammar

Technical Skills and Workplace Tools

Started by Victor Estrada in Questions, Opinions, and Thoughts Sep 13. 0 Replies

Thank you for your time. I am a graduate student in the Technical Communication program at The University of North Texas. The program has a unique focus on empirical research. For one of my classes, Digital Literacies, I am surveying technical communicators.The class is working through understanding what it means to be digitally literate, and we have discussed how being digitally literate includes (1) understanding how information and technology work, (2) how the source of information and…Continue

Tags: github, literacy, digital

I need some good examples of a Configuration Manual

Started by David in Questions, Opinions, and Thoughts. Last reply by Victor Estrada Sep 13. 2 Replies

Hello fellow writers,I have been the Technical Writer for a software company for the last 5 years. In that time I have created an online help environment, along with user guides for our various software platforms.I use MadCap Flare as my help authoring tool.Recently we have branched off from our normal business model and have created a stand alone Supplier Management Portal. This new SMP tool will be sold off the shelf to third parties and thus must include a Configuration or Setup Manual.I…Continue

Tags: Manual, Setup, Configuration

Technical Publications Department Managers

Started by Kenneth B. Weatherford in Careers. Last reply by Patsan Eugeniya Aug 20. 2 Replies

Like many of you, I started my technical writing career in a very inconspicuous way.  I had been writing for years, and I wrote manufacturing processes for a few companies.  I also had tenures as a trainer for three companies and started my own software company several years back.  I was more involved on the training side of the software, rather than the development.In 2001, I got my first technical writing job, on a contract.  I had an electronics engineering education, but I never finished…Continue

Did You Know?

Google +1 is here

Help spread the word about Technical Writing World by clicking the Google +1 icon below forum posts, blogs, and events. Your +1's will help friends, contacts, and others find the best content here when they search.

Featured Discussions

Loading… Loading feed

 
 
 

Sponsors

Become a sponsor

Site Announcements

Loading… Loading feed

Follow the TWW Twitter list.
Want us to follow you? Tell us.

Join our Circle

Visit our Google+ page

Events

Go Mobile

TWW loves to travel.

Info | Try

Around the Web

Did You Know?

If you see something interesting, you can Follow it.

© 2014   Created by Arnold Burian.

Badges  |  Report an Issue  |  Terms of Service