Technical Writing Resources

Thursday, December 30, 2004

writer's copyrights

The freelance writer's or first-time novelist's dream is to make the sale. But what happens next? Usually a contract will be sent by the editor outlining the rights you will be selling in exchange for your fee. Knowing the basic rights that you own in your work and the terms used by the publishing world can help avoid some nasty disappointments down the road.

What Do You Own?

The original author of a work owns the copyright to that work, unless he or she has assigned those rights to a third party. Copyright protection arises automatically, without any action taken by the author, the moment the work is fixed in a tangible form so that it is perceptible either directly or with the aid of a machine or device1. The owner of a copyright really owns a "bundle" of rights, like a bundle of sticks. Each stick or right can be sold or assigned separately to a third party.

Types of Rights Commonly Sold by Freelancers

First Serial Rights: A writer selling First Serial Rights is selling a newspaper, magazine or periodical the right to publish the story, article or poem for the first time in any periodical. All other rights remain with the author. First Serial Rights may be limited by geographical limits. For example, First North American Serial Rights ("FNASR") limits the license to periodicals published in North America, which includes the United States and Canada. First Serial Rights sold to an online publication cannot be limited by geographic area because the Internet is accessible by a worldwide audience.

One-Time Rights: A license of one-time rights, also known as simultaneous rights, grants the licensee the right to publish the work one time. This is a non-exclusive right which means the author may sell one-time rights to several publications at once -- normally to publications with different audiences.

Second Serial (Reprint) Rights: A license of Second Serial Rights gives the publication the right to publish the story, article or poem after the piece has already been published by another periodical. Second Serial Rights are nonexclusive; the author may license the piece to more than one publication.

All Rights: A license of All Rights is exactly that; the author is giving up all rights he or she owns in the work. The publisher may publish the work in any format -- print, film, electronic formats such as CD ROMs, and on the Internet without providing additional payment to the author. The author retains the right to state that he or she authored the work, but loses all the other rights to the work, including the right to publish, market or distribute the work, to create derivative works, or to perform the work.

Subsidiary Rights: In a book publishing contract, subsidiary rights are all rights owned by the author other than the right to publish the book. Subsidiary rights are negotiable in a book contract and will cover such potentially valuable rights as movie, film, videotape and audiotape rights, electronic rights such as CD ROM publishing, translation rights, book club rights, foreign rights etc. Subsidiary rights may be retained by the author so that the author's agent can negotiate separate deals for each of the rights, or the subsidiary rights may be sold to the book publisher so that the publisher can negotiate the rights. Each situation is different, however, many author's attorneys advise authors to retain the subsidiary rights on the grounds that the author's agent or attorney can obtain a more favorable deal for the author than the publishing house will.

Dramatic, Television and Motion Picture Rights: These are the rights licensed when selling work for use in a play, television or film. Most commonly, a work will be optioned under the following terms: the author is paid 10% of the agreed upon purchase price of the work, in exchange for the exclusive right to market and produce the work. The usual time limit for an option is one year. If the option expires and is not exercised, the author keeps the money and is free to option the work to someone else. Having a work optioned is no guarantee that it will ever be made into a film, play or television show.

Work For Hire: If an employee creates a work within the scope of the employee's employment, any work created belongs to the employer including the copyright to the work. This is called "work for hire". For example, a comedy writer for a sitcom writes the script for one episode. The script is the property of the employer, not of the writer because they were written within the scope of the writer's employment. The writer does not own the copyright to the script; the employer does. "Work for hire" can also occur in a freelance situation if the author signs a specially commissioned "work for hire" agreement before the development of the project. Unless an independent contractor (the writer, musician etc.) signs a specially commissioned "work for hire" agreement, the copyright to the work created will remain with the author of the work. If a specially commissioned "work for hire" agreement is signed, the copyright to the work created will belong to the developer of the project.

For example, Production Company wishes to develop and produce a documentary film. Production Company will enter into agreements with independent filmakers, writers, and musicians to create original work to which Production Company will own all the rights. In order to own the copyright to the finished product, Production Company will enter into specially commissioned "work for hire" agreements with each person who contributes original works to the final film. "Work for hire" agreements are common in the entertainment industry as well as in ghostwriting arrangements. The author must realize that if such an agreement is signed, he or she is giving up all his or her rights in the finished product forever. If a confidentiality clause is included in the contract (such as in a ghostwriting situation), the author cannot disclose the fact that he or she actually wrote the piece.

Electronic Rights: The licensing of electronic rights to a work in this day of expanding technological capabilities is a hot topic in the publishing industry. The best way to handle electronic rights is to clearly spell out exactly which electronic rights are being licensed and which are not. Electronic rights can encompass the rights to sell and distribute the work on CD ROM, to store the work in a database, such as Lexis-Nexus, to publish the work on the Internet, to archive the work on the Internet and the publishing of the piece on as-yet not invented electronic media. In a sense, the law of electronic rights is being written now by the writers, editors and publishers. Eventually, the terms will be recognized to have standard meanings in the industry. In the meantime, freelancers who write for online publications should ask the editor to spell out in plain language exactly what rights they are purchasing. If you don't understand what an editor means by "First Electronic Rights", then ask. Most editors are happy to explain their publication's policies. And keep copies of all the correspondence, whether it is by letter or by email. The correspondence itself constitutes a binding contract if it clearly shows what the parties intended.

Freelancers selling to the American periodical market should be aware of the recent court decision in Tasini v. New York Times, 93 Civ. 8678 (S.D.N.Y Aug. 13, 1997). In Tasini, District Court Judge Sotomayor ruled that in the absence of a contract that publishers are entitled to place all of the contents of their printed publications into an electronic database such as Lexis/Nexus or onto CD-ROM without the freelancers' permission and without compensating them for reprints. Judge Sonia Sotomayor based her decision on the U.S. Copyright Act which allows reprints without freelancer's permission or compensation if the freelance work is part of a "collective work".

There are a couple of important points to keep in mind about this decision. First, the Tasini ruling was in the context of a summary judgement hearing; there was no trial. The ruling has been appealed by the Plaintiff, Mr. Tasini, the President of the National Writer's Union ("NWU"). Furthermore, the ruling applies only in cases where there is no contract between the freelancer and the periodical. Since Tasini, almost every major newspaper has instituted formal contracts with freelancers specifically covering archiving, database rights and other electronic rights. Although many freelancers are unhappy with the form of these new contracts -- which generally require the freelance writer to relinquish all rights, electronic or otherwise -- many are signing the contracts. Finally, the ruling is silent on the issue of Internet publishing and does not apply to situations where there is a contract between the freelancer and the publication.

Conclusion

The novice writer must learn the business end of the writing and publishing industries in order to survive. Most freelance writing agreements are not complicated documents and most writers are perfectly capable of understanding and negotiating their own contracts if they get in the habit of reading carefully, asking questions when they don't understand something, and taking the time to learn the basic terms used in the industry. The time spent researching these issues will be well worth the time spent. Most agents will not represent freelancers or short story writers because the compensation is too low for it to be worth their time and effort. However, there are certain situations when it is strongly advisable to have a knowledgeable agent or attorney do your negotiating for you. Book contracts, for example, are usually complex documents which contain a myriad of pitfalls for the layperson which, as a general proposition, should not be signed without having an attorney review it first. So, make time to learn the business basics of being a writer. After all, it's your work -- shouldn't you know what your rights are?

Clarie E. White
http://www.writerswrite.com/journal/sept97/cew2.htm

Wednesday, December 29, 2004

technical writer's resume

FIRST OF ALL, above any considerations of technical aptitude, organizational habits, or familiarity with documentation technologies, you must be able to WRITE - and this must be displayed through your professional looking resume!

Of course you can write, you're a technical writer aren't you?

On the contrary, many people involved in the field of technical documentation concentrate solely on trying to be experts in the technology they are documenting, and completely ignore the fact that the knowledge they are developing must be communicated to someone else--most likely someone with far less technical aptitude. As a result, they view the material that they write as "dry" or "non-creative", and this underlying philosophy becomes very obvious through sentences and paragraphs that are lifeless and uninteresting.

YOU must show that you are different! Through your resume, you must convey the fact that you have a passion for technical documentation and understand its place in the overall communication environment.

Here is a a comprehensive list of qualities that the perfect technical writer would possess. A few of the main areas are briefly described below. It will be of EXTREME IMPORTANCE that you find a way to show these qualities to your audience through your resume - they will set you apart from the other candidates and increase your chances of getting the INTERVIEW!

Technical writer resume qualities #1

You must display/convey the ability to translate a morass of technical details into a clear hierarchy of concepts. Such a quality encompasses the ability to think logically, and then clearly communicate one’s thoughts to others. In many cases, the writer must have the ability to communicate this information in different ways, depending on the audience. This is, after all, what technical writing is all about.

Technical writer resume qualities #2

Point out that you have knowledge and give attention to document design. This is not about being a graphic designer. Technical writers must understand the relationships between various components of a document, and be consistent in applying them. Such attention to document design will help the reader understand the concepts being presented.

Technical writer resume qualities #3

Consistency in editing. The writer should have a solid understanding of the rules of the language he or she is working in, know how to use them properly, and know when those rules can be bent.

Technical writer qualities #4

Ability to plan one's workload. Another logical thinking quality, this ability allows the writer to take a murky collection of project requirements and translate them into a clear and comprehensive set of tasks. The resulting schedule that can be developed will help identify potential trouble areas, and minimize headaches for both writers and their managers.

Technical writer qualities #5

Proper and consistent reporting habits. This quality involves the ability to understand that tasks assigned by a manager are a priority, and that it is up to the writer to figure out when and how the task can be completed, or to alert the manager to potential problems and provide alternatives. It’s alright to be told how to do this the first few times, but it is a skill that the writer must pick up quite quickly.

Technical writer qualities #6

Establishing and maintaining a good rapport with clients. This starts with the client's first impression, so good presentation and appearance is a must, along with a pleasant demeanour. Writers should have the ability to identify a client’s requirements and then find a blend between what the client wants and what the writing team can offer.

Technical writer resume qualities #7

Good knowledge of documentation tools. These days, knowing how to properly use a wide range of wordprocessing packages or on-line help tools is crucial. Knowing how to use the tool is often a key aspect in integrating the final product into a client's environment.

Technical writer resume qualities #8

Desire and ability to learn new concepts. No one can be an expert in every subject area, but the technical writer is often required to write about a wide range of topics. Being able to perform research efficiently, and quickly pick up key knowledge components is a vital skill in ensuring the versatility of any technical writer.

Technical writer resume qualities - wrap up!

Of course, there are some qualities that will be more important to your prospective employer than others, and you will have to do your research and find out what your evaluators are looking for!

No writer will ever possess the perfect set of skills. The main goal for you should be to highlight core set of skills that your employer will be looking for - DO YOUR RESEARCH!

http://www.master-of-writing-resumes.com/writer-resumes.html

Tuesday, December 28, 2004

Automatically Repair Office Applications

Caution

Choosing this option will discard many of your customized
settings and restore default settings. For instance, the following will be set
back to the state they appeared when you first installed Office
:
  • The Assistant character selection
  • Most-recently-used entries on the
    File menu will be removed
  • The size of the application window
    for all applications
  • Menu and toolbar position and any
    customizations
  • Customizations and additions to
    Office Shortcut Bar
  • The security level for each
    application
  • View settings within the application,
    such as the Calendar view in Outlook

Your User Name and Initials will also need to re-entered when you restart
your Office applications.

  1. On the Help menu, click Detect and Repair.

To restore the program shortcuts to the
Windows Start menu, make sure the
Restore my shortcuts while repairing
check box is selected.

  1. Click Start.

Notes

  • This feature is not available for
    Office applications earlier than Office 2000.

  • This procedure detects and repairs
    problems such as missing files and registry settings associated with all
    installed Microsoft Office programs. It will not repair personal files, such
    as spreadsheets or documents.

  • If the
    Detect and Repair
    command does not fix the problem, you might need to
    reinstall Microsoft Office.

Tuesday, December 21, 2004

ways to reduce file size in MS Word

Compress pictures: Compressing pictures can discard extra information — such as cropped areas — from the file, reduce image resolution, and where possible, make the graphics file format more efficient.

Turn off fast saves: Using fast saves to save a document requires more disk space while your document is open than using a full save. You may be able to save disk space by clearing the Allow fast saves option.

Embed only the TrueType font: Embedding TrueType fonts in a document increases its size. If you embed TrueType fonts, you may be able to reduce document size by selecting the Embed characters in use only option. This option embeds only the font styles used in your document. Also, if you used 32 or fewer characters of a font — for example, a few symbols or a headline — Microsoft Word embeds only those characters.

Delete versions: Creating multiple versions of a document using the Versioning feature may increase file size. To check whether a document contains other versions, click Versions on the File menu. If other versions exist, you may be able to reduce the file size by deleting the oldest versions.

Convert embedded objects into graphics: Adding embdded objects [embedded object: Information (object) that is contained in a source file and inserted into a destination file. Once embedded, the object becomes part of the destination file. Changes you make to the embedded object are reflected in the destination file.] to a document can increase its size. If you don't need to update an embedded object contained in a document, you may be able to reduce the file size of that document by converting the embedded object to a graphic. After converting the object, you can edit it just as you would edit any other Word graphic. After an embedded object is converted to a graphic, it can't be changed back to an embedded object.

Link graphics: Use a linked object [linked object: An object that is created in a source file and inserted into a destination file, while maintaining a connection between the two files. The linked object in the destination file can be updated when the source file is updated.] instead of an embedded object. With a linked object, you can easily update information in your Word document when the information is changed in the source file [source file: The file that contains information that was used to create a linked or embedded object. When you update the information in the source file, you can also update the linked object in the destination file.]. Linked data is stored in the source file. The destination file [destination file: The file that a linked or embedded object is inserted into. The source file contains the information used to create the object. When you change information in a destination file, the information is not updated in the source file.] stores only the location of the source file but still displays the linked data.

Monday, December 13, 2004

Creating Documentation in Microsoft Word

To save costs, many small businesses take the do-it-yourself route to publishing product and support documentation. The tool of choice is often Microsoft Word - after all, you probably already have a copy of it and know how to use it reasonably well. But while using Word to *develop* your materials is an acceptable choice, using it to *publish* documentation is not! Read on to learn some of Word's shortcomings as a publishing method, and what alternatives are available.

SECURITY ISSUE #1: THERE IS NO "DOCUMENT SECURITY"

Simply put, there is no "document security" in Word. Anyone with a copy of your document can change the text, formatting, layout, form fields, your copyright notice, and so on. Word does offer password-protection for documents, but this doesn't prohibit the reader from changing anything while viewing it or saving it to another file name.


SECURITY ISSUE #2: CAN'T HIDE THE META DATA

Even more critical is "meta data" - private information such as the author's name (or network ID), name of the company your copy of Microsoft Office is registered to, total amount of time the document was worked on, and so on. This data is embedded automatically in every single Word document. To see what kind of information you could be leaking out, open any Word document and click on File / Properties.

Microsoft admits there is no easy way to remove all of the metadata information, although some of it can be "reset" via various procedures. Apparently an option exists in the new Word 2002 (Office XP) to make this easier, but again, it's not a simple procedure and the onus is still on you to remember to do it.


COVER YOUR TRACKS (TRACKED CHANGES, THAT IS)

Word has a feature called "Track Changes" that helps people sharing a document to track what has been changed and by whom. If you use this feature but forget to fully disable it before distributing your document, you now have an instant, visible audit trail of document revisions. If you had any sensitive information in there, consider it no longer private.

Alcatel, an American telecommunications company, fell victim to this mistake earlier this year when they published a Word-format press release concerning a known security vulnerability in their DSL modem products. Read the story at
http://morons.org/articles/1/188.


THE INCREDIBLE SELF-INFLATING DOCUMENT

A 200-page Word document with 25 screen shots can easily total 5MB in size. Add more graphics or cross-references, and watch the file size magically balloon to 8MB or more. Your customers will probably not appreciate having to download a file of such a size, especially if they're on a slow dial-up connection - and especially if they're trying out your product before buying!
By the way, Word's "Fast Save" feature is NOT your friend - it is known to horribly bloat and corrupt documents when you least expect it. Turn off the "Fast Save" feature under Tools / Options / Save.


NOT EVERYONE OWNS A COPY OF WORD

Microsoft Word may be the world's most popular word-processing package, but that doesn't mean everyone has a copy of it. Customers may be using an operating system that doesn't support it, they cannot afford a copy, or they've found another word-processing program they like better.
What alternatives have you provided for these folks to use your documentation? Microsoft Word is an expensive program, and it's unfair to require customers to own a copy just to be able to read your user manual.


SO WHAT ARE THE ALTERNATIVES?

Granted, no publishing method is 100% perfect, but there are still a lot of options available to the do-it-yourselfer. Adobe PDF format, HTML web pages, and embedded Help files are excellent, low-cost ways to distribute your documentation while maintaining various levels of control over layout and formatting, security, file size, and accessibility.

Adobe Portable Document Format (PDF) files are like a "picture" of your original document, which means the text and layout cannot be easily changed. PDF's have a built-in navigation system called "bookmarks", offer excellent security, and are small in size. And best of all, you can still use Word to develop your document - simply convert it to a PDF file via a button in your Word toolbar! Your customers will require the free Acrobat Reader to view the files. Check out
http://www.adobe.com/acrobat for more information.

HTML files are also small and load quickly, provided they are not too graphics-intensive. Every operating system today has a built-in or free HTML browser. However, it's recommended you leave out features such as frames, scripting, or Flash animation that many browsers do not support. You can use any HTML editor to create these files, and your Webmaster can make you a template to ensure the document style integrates with your overall website design.

Embedded help (commonly called "online help") are those screens that magically pop up when you click the 'Help' button in a program. Help systems can be embedded right into an application or distributed as small stand-alone files, depending on your needs. A single Help system can also be made viewable on several different operating systems. Two excellent Help Authoring Tools are RoboHELP (
http://www.ehelp.com) and ForeHELP (http://www.forehelp.com).

Ultimately, the choice of which format(s) to use will depend on your individual situation... but in every case, there are excellent, low-cost alternatives available to publishing your documentation in Microsoft Word format. An experienced documentation specialist will be able to evaluate your situation and recommend the most appropriate options. Good luck!

Author: Tanja Rosteck
tanja@words4nerds.com