Tag Info

New answers tagged

1

Word is acceptable for short documents. Make sure to set up paragraph styles and always use them (no manual formatting). When your manual exceeds 50 pages or you have layout requirements beyond the basics, Word becomes increasingly troublesome: instability and document corruption are common in large documents. You'll also run into trouble with the way Word ...


1

Do some volunteer work for non profits that need technical writing, then list that work on your resume. It won't take much to get someone interested in you. Then take a contract doing documentation. Companies who create in-house software are notoriously deficient when it comes to technical documentation, and they know it. Anyone who wants to do that job ...


2

In many ways you approach this the same way you would approach any other new project: Review any available high-level descriptions (like functional specifications) and user stories: what is this thing and how are people meant to use it? Identify your key contact (if you don't have one, ask your manager how to get one) and schedule an overview discussion. ...


0

I believe that you want to use (structured) FrameMaker, perhaps integrated with RoboHelp if you need a variety of output types. Both products are part of Adobe's Tech Comm Suite product (and you actually need the suite for FM-to-RH integration). There is a ton of material about how to use FrameMaker. To help you, here's the link for a long list of ...


0

Why not test the hypothesis, starting with the negative test? You are unhappy in your current career. You have some background but nothing official. A BA in English might or might not be a meaningful credential (in my experience it depends on the school and the program's focus -- literature is probably a "no" but actual writing is more significant). So ...


0

Almost every technical writer I've ever worked with has an undergraduate degree in English or Literature or something related to writing, and no Masters degree. So you don't have to have a technical or science degree, or even a Technical Communications degree to get into tech writing. And you definitely don't have to have a Masters of any kind. The Masters ...


5

LATEX isn't a text editor, it is (broadly defined) a markup language. The alternatives would be things like markdown, asciidoc, docbook, or simply using HTML directly, in tandem with your favorite plain text editor. Docbook and HTML are "heavyweight" markup languages (you need a tag for every paragraph, etc), whereas markdown and asciidoc are lighter and ...


0

Having taken the considerable amount of time that it takes to learn how to use DTP software (most recently when I had the job of laying out a magazine) and knowing what results you can achieve, I would definitely recommend you just use a word processor such as Word or Open Office. What you are doing doesn't need extremely precise control over layout, ...


5

I think MS Word and Open Office would be the obvious candidates. MS Word pretty much dominates the market. Open Office is there for people who just want to rebel against Microsoft. I'd need a very good reason to use anything else, as to function in a Western business, government, or academic environment these days you pretty much have to use MS Word at some ...


1

For Mac, take a look at BBEdit. In particular, it has fully supported GREP search-and-replace functionality. There's an e-book that can be bought with the BBEdit product, which is highly recommended because it provides usage examples for the GREP functionality. For Windows, try Notepad+. In addition to the base product, there are any number of plug-ins that ...


4

I am not a lawyer and this is not legal advice. First, check any license terms that accompany Company S's documentation. They might have published it with the intention that other vendors will incorporate it (e.g. some Apache platforms), or they might not intend that but allow it under their license (e.g. Stack Exchange, or anything else that uses the ...


1

This is a legal issue. Specifically, a copyright issue. Assuming we are talking about the United States, company S owns the copyright to their documentation. It is illegal for company M or anyone else to incorporate company S's documentation into their own without obtaining the right to do so from company S. Consult an attorney. Also, take a look at The ...



Top 50 recent answers are included