The social network for technical communicators
The social network for technical communicators
you might know about the recent trend of cloud computing. If you don’t, well you should. Short cut is, it’s not any rocket science technology, the way we work tough is different. We share our documents on YouTube, Facebook and…Continue
It was a hot Sunday afternoon. I was home alone watching one of my favourite movie. Though this movie is a bit romantic love story, I was surprised to myself watching this movie. You might be guessing what is surprising in watching the all-time…Continue
When did you last hear people talking on TV about the importance of writing skills? If it’s been too long, today is your lucky day. AM Northwest hosts Helen Raptis and Dave Anderson interviewed Marcia Riefer Johnston…Continue
Technical Writing has come a long way. Users just do not have time to read through a 500-page manual. They want something interesting or probably someone to demonstrate how a certain task is performerd rather than having to go through a…Continue
Technical Writing World averages 100,000 pages views from over 14,000 unique visitors per month, excluding bots and crawlers. Consider becoming a sponsor.
If you have a blog outside of TWW, you can promote it here. In the left column of your profile page, click Add RSS.
Hi Forum,Have you worked on software product deployment guides before. I'm struggling to figure out where I can ideally place the deployment guide in my product documentation.Should it be inside the User's Guide, or inside the Installation Guide or should it be a separate section altogether. I am hesitant to make it a separate sections because that would make my "list of main topics" too lengthy and since I talk about server extension and troubleshooting scenarios inside the User Guide, I don't…Continue
Dear forum,I work in the IT sector and I have a question on where the Quick Start guide best fits in product documentation. Currently, I have listed it as follows:About the productInstallationQuick Start GuideUser GuideI have basic instructions on how to install and set up the product in the Quick Start Guide too. So I am thinking if it is better to move it right after the About section.Do you have any suggestions for me please? Is the Quick Start Guide irrelevant nowadays?Continue
Hi guys,This is a newcomer saying "Hi" to the forum. I am on the verge if changing job tracks to technical writing because I do not quite enjoy what I do right now. I am in QA but I have a passion for documentation.My Question:Are there any writers here who changed tracks from a software development or QA job? If so, what are the implications of such a job change?Thanks guys.Continue
Hi,I wrote an email to a person asking about some clarrifications. The email that I wrote was during the morning time, so I started the email with "Hello XYZ, A very Good Morning to you." Well, during afternoon when I was just checking the Sent items from my outlook, I thought whether it's appropriate to say, "A very Good Morning." I am not sure when is he going to read the email. He may read it during afternoon, evening or at night.It sounded weird or something to me when I was reading my…Continue
I need to create a questionnaire for new clients to fill out prior to implementation. What software do you recommend for something like that? I need something that offers "save as you go" functinoality.Example:What is the name of your company? *What is your first name?*In what states do you write business?*Continue
Hi All, I have a major dillema. I work in a company where we create user guides, admin guides, installation, troubleshooting and online help docs.A requirement from the Dev team has arised about an Application document which doesnot have a UI, and acts as a gateway for the order flow across various spaces. So they just have the rules for managing this complex application. The data basically flows from the Sales Database.Now my question is to create what kind of document that accomodates these…Continue
I have a problem regarding whether or not to use the definite article “the” along with a product name. 1. Use “the” or not before a noun-version product name?It seems that when a product name is used as an adjective (that is, being followed by a modified noun), “the” is usually required (When I said “usually”, I meant “there may be exceptions.” See my second question below.) For example, “The SC000™…Continue
I am creating a first ever Style Guide for my company.We create web content, User Guides, Marketing Communications (on line and technical oriented docs), White Papers, and Press Releases.As you might suspect the styles, even within a single document, are inconsistent.On one hand, the techs want Times for everything, while Sales want Impact, Garamond, etc., and I need facts to help me "draw a line in the sand."Do you know of, and can point me to resources/research that recommends using specific…Continue
Hola, folks! I'm new, so be nice, but be honest. :)I came from a desktop production background, and I fell in love with the Adobe CreativeSuite. I have InDesign, Illustrator, Photoshop, and even a little Dreamweaver on my resume.Now that I'm a technical writer...as much as I LOVE InDesign as a layout program, I'm not sure how long-term user-friendly it is for longer documents. I've so far had issues with text threading, anchored objects, and those FREAKING section numbers. Word handles…Continue
Hello Readers,I am a bit confused about refering to the audience or reader of the document.I am not sure in which document, how should I refer. For Instance, "You need to verify the ....." or "User need to verify the...."?Another question is whether we can change from "User" to "You" and Vice-a-Versa at some point in the document?Regards,Amar.Continue
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.