Technical Manual Writing Agreement
Technical Manual Writing Agreement
______________________, referred to as PROGRAMMER, and
______________________, referred to as WRITER, agree:PROGRAMMER has authored a program entitled ______________________, and WRITER shall prepare manuals and other documentation for the same under the terms and conditions stated herein.
On or before ________________________, PROGRAMMER shall provide a copy of ______________________ to PROGRAMMER. Said program shall be substantially complete, that is, that the program shall perform all its major functions intended to be and shall be free from major defects. Some of the functions may be linked to stub
files. However, PROGRAMMER shall provide at the earliest opportunity functional code for such stubbed versions.In the event that the program is not timely delivered or there are major defects in the same, the time for the completion of the manual shall be extended accordingly.
In the event of a substantial redesign, including the addition of major new functions, or any re-design of the end user interface, WRITER shall be entitled to reasonable additional compensation to be negotiated by the parties in good faith. Substantial re-design shall include but be limited to:
a. change in operating system of the program, such as from MS-DOS to Windows;
b. addition of major functions which comprise an addition of 20% or more of the total original components;
c. re-coding which comprises 25% of more of the source code modules.In the event that the WRITER discovers any programming inconsistencies (bugs) WRITER shall immediately inform PROGRAMMER of the same.
WRITER shall prepare a manual suitable for use by ___________________________, of approximately
______________________________ words.WRITER shall provide ______________________ charts and __________________________ illustrations. The illustrations shall be ________________________.
WRITER shall provide a quick reference card detailing the basic program functions suitable for use by users needing command sequences or other information for the elementary use of the major functions of the program.
WRITER shall receive credit in the final distributed version of the manuals and other materials as the author.
WRITER shall deliver the manual and other materials provided for herein on or before _____________________, unless extended as is provided herein. Time is of the essence in this contract.
WRITER shall provide in addition to printed copies, a diskette of the manual and other contents in ASCII or any other mutually agreeable file format.
WRITER shall assist the PROGRAMMER during beta testing programs, if such are held, in the evaluation of the materials delivered by the WRITER to beta testers. Such assistance shall be limited, unless expressly contracted for herein to telephone or mail consultants of an intermittent, as needed basis. Based upon the results of the beta program, WRITER shall in good faith use WRITER’s best efforts to improve the manual based upon the test.
In consideration of the payments made herein, WRITER herewith unconditionally sells and assigns the copyright to the manual to PROGRAMMER. In applications or other filings related to the copyright, PROGRAMMER may be named as the author. For purposes of the United States Copyright Code, PROGRAMMER will be considered
to be the statutory author of the materials delivered herein.WRITER agrees to execute any and all documents requested by WRITER to establish the full ownership of PROGRAMMER in the manuals and other materials prepared herein.
WRITER shall be paid as follows:
A total fee of $______________________
(_______________________________________________ & ______/100 dollars), due as follows:
___________________________________________________________This is the entire agreement between the parties and the same may only be varied in writing.
Dated: ___________________
________________________________
______________________ By Programmer/Owner
_______________________________
______________________ By Technical WriterTechnical Manual Writing Agreement
Review ListThis review list is provided to inform you about this document in question and assist you in its preparation. Technical manual writing is tricky because the writer has to be intimately familiar with the program to make the project work well. This is rarely the case in fact. As a result, most technical manuals are not as effective as they should be for the end user’s purposes.
1. Make multiple copies. Give each signer an original copy.
2. Be sure the technical writer has enough documentation, information, and skill, as a practical matter, for them to succeed in the project. Otherwise, both parties will be unhappy with the outcome-and no legal document will cure that unhappiness, no matter how well crafted.
Frequently Asked Questions
What is a Technical Manual Writing Agreement?
A Technical Manual Writing Agreement is a contract between a PROGRAMMER and a WRITER for the preparation of manuals and other documentation for a program. Under the agreement, the PROGRAMMER provides a substantially complete program, and the WRITER prepares the documentation according to the stated terms and conditions. The agreement outlines responsibilities, timelines, and conditions for compensation.
What does 'substantially complete' mean in a Technical Manual Writing Agreement?
In this agreement, 'substantially complete' means that the program performs all its major intended functions and is free from major defects. Some functions may be linked to stub files, but the PROGRAMMER must provide functional code for those stubs at the earliest opportunity. This definition sets the threshold for when the WRITER's documentation work can proceed without delay.
What happens if the program is delivered late or has major defects?
If the program is not delivered on time or contains major defects, the time for completing the manual is extended accordingly. This provision protects the WRITER from being held to the original deadline when the PROGRAMMER's delays or defects impede documentation. The extension is automatic and tied to the delay or defect.
What is a stub file in the context of this agreement?
A stub file is a placeholder for a function that is not yet fully implemented. The agreement allows some functions to be linked to stub files, provided the PROGRAMMER supplies functional code for those stubs as soon as possible. This allows the WRITER to begin documenting the program even if some features are incomplete.
When is the WRITER entitled to additional compensation?
The WRITER is entitled to reasonable additional compensation in the event of a substantial redesign, including the addition of major new functions or any redesign of the end user interface. The additional compensation is to be negotiated by the parties in good faith. This ensures the WRITER is fairly paid for the extra work caused by significant changes.
What constitutes a substantial redesign under this agreement?
A substantial redesign includes the addition of major new functions or any redesign of the end user interface. The agreement specifies that such changes trigger the WRITER's right to additional compensation. The definition is broad enough to cover significant alterations that affect the documentation scope.
Who provides the program to the WRITER?
The PROGRAMMER provides a copy of the program to the WRITER by the date specified in the agreement. This delivery is a prerequisite for the WRITER to prepare the manuals and documentation. The PROGRAMMER must ensure the program is substantially complete at the time of delivery.
What are the obligations of the PROGRAMMER in this agreement?
The PROGRAMMER must deliver a substantially complete program by the agreed date, ensure it is free from major defects, and provide functional code for any stubbed functions as soon as possible. The PROGRAMMER is also responsible for notifying the WRITER of any substantial redesign. These obligations are essential for the WRITER to perform their documentation work.
What are the obligations of the WRITER in this agreement?
The WRITER is responsible for preparing manuals and other documentation for the program under the terms and conditions of the agreement. The WRITER must complete the documentation within the time frame, which may be extended if the PROGRAMMER delays delivery or if major defects are found. The WRITER is also entitled to negotiate additional compensation for substantial redesigns.
How is additional compensation determined for a substantial redesign?
Additional compensation for a substantial redesign is to be reasonable and negotiated by the parties in good faith. The agreement does not specify a fixed amount or formula, leaving it to the parties to agree on fair compensation. This approach allows flexibility based on the scope of the redesign.
