Developers Dont Do Docs How to Get Your Technical Documents Done Right - by Tammy Young, technical writing consultant for The Essay Expert

Developers Dont Do Docs How to Get Your Technical Documents Done Right - by Tammy Young, technical writing consultant for The Essay Expert Why not have developers write technical documentation? After all, they likely designed the software, or at least had a hand in the design. Don’t they know the software best? Yes, perhaps they do, but that does not make them the best candidates for writing manuals, or even Help files. The truth is that most developers do not like writing docs. They prefer writing code. When pressed into service for documentation, they will complete the task as quickly as possible in order to get back to their preferred job. The resulting documentation is likely to be too sophisticated for an end user. It will often assume too much technical savvy from current customers and a level of product knowledge that new users cannot possibly have. Although few and far between, there are software engineers who enjoy the break from design and code to write documentation. Some of these people even write well. But beware! If you are one of those lucky product development managers who can rely on an engineer for docs, be sure to schedule time for documentation QA from a technical writer or the QA team. Developers know the product so well, they can’t foresee the mistakes that end users make, and they don’t write instructions to prevent those errors. This oversight leads to increased Help Desk calls for problems that could have been avoided with clearer docs. In contrast, professional technical writers approach the product from the point of view of the end user. Like customers, they don’t know all the ins and outs of the product design. Therefore, they can anticipate where users will have trouble and write detailed, even elementary, steps to improve the user experience. Their own questions can be used to build a dynamic FAQ list for product Help files or a user Wiki community. Developers’ time spent on docs is reduced to one interview and occasional questions, usually via email, to clarify points as the tech writer completes the docs. The result is a set of manuals and Help files that provide solutions for users before they even have problems, preventing support calls and promising more satisfied customers. Contact The Essay Expert for professional writing assistance with your technical documentation. Our experienced technical writer will be a seamless addition to your development team, writing everything from Help files and manuals to last-minute ReadMe and release notes. The results? High quality product documentation and happy developers. Category:Professional WritingBy Brenda BernsteinSeptember 30, 2009

Difference Between Por Qué and Para Qué in Spanish

Difference Between 'Por Quà ©' and 'Para Quà ©' in Spanish Although both para quà © and por quà © used in questions in Spanish are usually translated as why, there is a subtle difference in meaning between them. Simply, the question  ¿Por que? might be thought of as Why? the question  ¿Para quà ©? might be thought of as What for? Por quà © addresses the cause of something and looks back to the reason or motivation for the action. Para quà © looks forward to the purpose, goal, objective or intention of something. Note that there are four different ways to write  por  quà ©, such as one word, two words, with and without an accent over the e, and there are differences in meaning. Ways to Use Para Quà © and Por  Quà © It is often possible to substitute  por  quà ©Ã‚  for  para quà ©, but not always the other way around. In situations where  por  quà ©Ã‚  is substituted for  para quà ©, the point of emphasis in the sentence changes. Spanish Sentence English Translation Para qu vas al dentista? Why are you going to the dentist? [For what reason?] Para qu quiere pagar ms? Why does he want to pay more? [For what purpose?] Para qu estudias espaol? Para viajar? Why to do study Spanish? For travel? [For what reason?] Por qu muri el soldado? What caused the soldier to die? Para qu muri el soldado? For what purpose did the soldier die? Por qu gan la eleccin? What caused her to win the election? Para qu gan la eleccin? For what purpose did she win the election? Por qu es eso? Why is that? Para qu es eso? Whats that for? Por qu nieva mucho ms en Nueva York que en Madrid? Why does it snow much more in New York than in Madrid? Por qu hay pocos trompetistas en comparacin con otros instrumentistas? Why are there few trumpeters in comparison with other instrumentalists? Por qu brilla el sol? Why does the sun shine? The Difference Between Por Quà ©, Porque, Por Que,  El Porquà © Para quà ©Ã‚  and  por  quà ©Ã‚  are somewhat easier to differentiate, but what happens when there are four words spelled almost exactly the same way and each with slightly different meanings:  por quà ©, porque, por que and porquà ©? Something as simple as an accent mark can make all the difference in a sentence. Por quà ©Ã‚  is, together with  porque, one of the most often used of the four  porques. It means  Ã¢â‚¬Å"why,† very much the same way as it is used in English.  When you ask a question using  Ã¢â‚¬Å"why,† and you get an answer beginning with, â€Å"because, thats a good way to remember what  porque, as one word, with no accent, means. Spanish Sentence English Translation Por qu has venido? Porque tengo tiempo libre. Why have you come? Because I have some free time. Por qu no comes pizza? Porque no tengo hambre. Why have you come? Because I have some free time. Por qu te vas? Porque ya es muy tarde. Why are you leaving? Because it is too late already. El  porquà ©Ã‚  is a Spanish noun meaning the reason. It is written  with an accent mark over the  e and requires the definitive article el, meaning the. For example,  No entiendo  el porquà ©Ã‚  de tu decisià ³n, which means, I do not understand the reason behind your decision. Por  que,  two words without an accent mark, is the least commonly used.  It can be translated as â€Å"for which.† It is used as a prepositional phrase. For example,  Este es el motivo por que no llamà ©, translating to, This is the reason for which I didnt call.