Shirley Yardeni - syc-twriting.co.il · Doc. Version: 2.04 Date: 25/4/2011. Word 2010 Style Guide Doc. Version: 2.04 Date: 25/4/2011 Page 4 of 63 SYC-Word2010StyleGuide Table of Contents

Shirley Yardeni

/

Technical Writing and Translations English/Hebrew

.08-9707631Tel. :052-481-6240Mobile:

": .net.il012@12syc :Email :twriting.co.il-http://www.sycSite:

•-DVD••••••)'(

•Word : )template ( )look & Feel.(

•) ,(

•)Homeland Security(

•••

•)(•Word

)(Template )Look & Feel(

SYC Technical Writing & Translations H/E 16 Nachal Yarkon St. Modiin Israel 71700 Tel-Fax: 972–8–9707631 Mobile: 972-52-481620 e-Mail: [email protected]

Documentation

Word 2007 Style Guide Doc. Version: 2.04

Date: 25/4/2011

Word 2010 Style Guide Doc. Version: 2.04

Date: 25/4/2011

Page 4 of 63 SYC-Word2010StyleGuide

Table of Contents Preface ......................................................................................................................................... 7

1. Introduction ........................................................................................................................ 14

1.1. Category Templates .................................................................................................. 15

1.2. Document Structure .................................................................................................. 16

1.2.1. Preface Adjustments ...................................................................................... 17

2. General Conventions ......................................................................................................... 18

2.1. Company and Product Names ................................................................................... 18

2.2. Grammar and Phrase Conventions............................................................................ 18

2.3. Sentences and Paragraphs ....................................................................................... 19

3. Page Format ....................................................................................................................... 20

3.1. Headings................................................................................................................... 20

3.1.1. Regular Headings ........................................................................................... 20

3.1.2. Appendix Headings ........................................................................................ 20

3.2. Page Setup ............................................................................................................... 21

3.3. Headers and Footers ................................................................................................. 22

3.3.1. Header Attributes ........................................................................................... 22

3.3.2. Footer Attributes ............................................................................................. 23

3.4. The Cover Page ........................................................................................................ 24

3.5. Table of Contents (TOC) ........................................................................................... 25

4. Style and Formatting .......................................................................................................... 27

4.1. Text Styles ................................................................................................................ 28

4.1.1. Structured Styles ............................................................................................ 28

4.1.2. Emphasizing Names ....................................................................................... 29

4.1.3. Date Format ................................................................................................... 29

4.1.4. Em- and En–Dashes ...................................................................................... 31

4.2. Numbering ................................................................................................................ 32

4.3. Tables ....................................................................................................................... 33

4.4. Functional Styles ....................................................................................................... 33

4.4.1. Style: NotKeepWithNext ................................................................................. 34

4.4.2. NewPage ....................................................................................................... 35

5. Managing Figures and Screenshots .................................................................................. 36

5.1 How to Insert and Manage Figures ............................................................................ 37

5.1. Dealing with Large Screens ....................................................................................... 40

Appendix A. Installing Gadwin PrintScreen ..................................................................... 42

Word 2010 Style Guide Doc. Version: 2.04

Date: 25/4/2011

Page 6 of 63 SYC-Word2010StyleGuide

List of Figures Figure 1. Screen Portions ..................................................................................................... 18

Figure 2. Different Odd, Even and First Pages...................................................................... 21

Figure 3. Header Example ................................................................................................... 22

Figure 4. Footer Example ..................................................................................................... 23

Figure 5. Filename in Footer ................................................................................................ 23

Figure 6. The Cover Page .................................................................................................... 24

Figure 7. TOC Example ....................................................................................................... 25

Figure 8. TOC Settings ........................................................................................................ 26

Figure 9. Access Styles Window .......................................................................................... 27

Figure 10. Style Pane Options................................................................................................ 27

Figure 11. Inserting a Date ..................................................................................................... 30

Figure 12. Inserting an En/Em Dash ....................................................................................... 31

Figure 13. Header Row Gray.................................................................................................. 33

Figure 14. NotKeepWithNext Style ......................................................................................... 34

Figure 15. Keep Lines Together ............................................................................................. 34

Figure 16. NewPage Style...................................................................................................... 35

Figure 17. Torn Paper, Single and Double Lines .................................................................... 40

Figure 18. Single–Lined Torn Paper ....................................................................................... 40

Figure 19. Double–Lined Torn Paper...................................................................................... 40

Figure 20. Table of Figures Options ....................................................................................... 41

Figure 21. Display Gadwin PrintScreen .................................................................................. 42

Figure 22. Gadwin PrintScreen Properties .............................................................................. 42

Figure 23. Figure Caption....................................................................................................... 46

Figure 24. Field>SEQ>Identifier ............................................................................................. 52

Figure 25. SEQ Formatting .................................................................................................... 53

Figure 26. SEQ Switches ....................................................................................................... 53

–General Description

20110208-BOSID-UG Page 15 of 63

1.1.4. Herd Book The Herd Book is an official record of all the individuals that belong to a registered herd and its owner. The Herd Book is designed to contain all the relevant information for controlling the cattle that is scattered around the country. This is where the first cattle registration takes place, and it is done by hand writing.

1.1.4.1. Managing the Herd Book information

It is the responsibility of the crew leader to see that the Herd Book pages are delivered as follows:

Periodically, send the Herd Book original page (white) to the head office.

Stamp the country official stamp on the pink copy and give it to the LC1.

When the entire Herd book is used, send it (with the yellow copies) to the head office.

Each numbered row in this form represents one cow. For detailed information on how to fill-in the cow information in the herd book, refer to 4.2.3. How to register the cow in the Herd Book on page 47.

Figure 3. Herd Book Page

1.1.5. Cattle Ownership Certificate (COC) The Cattle Ownership Certificate is the actual ID card of the cow; that is, a Cattle Ownership Certificate is issued for each registered cow. For detailed information on how to fill-in the Cattle Ownership Certificate information, refer to 4.2.4. How to fill-in the Cattle Ownership Certificate on page 49.

Figure 4. Cattle Ownership Certificate

Village Name: ___________

–Screen Description

20110208-BOSID-UG Page 29 of 63

2.3.4. Database Screens

Figure 17. MC Database Screen

In this screen

This menu determines which data is displayed. To eliminate the displayed data, enter a text string to the right of the menu.

Searches the entered string.

Next/Previous. Enables to view additional database pages.

OK Saves the recently entered details and returns control to the previously displayed menu.

Proceeds to the next cow (relevant to inspection issues).

Cancel Cancels the recently entered details and returns control to the previously displayed menu.

Typewriter Displays the virtual typewriter.

Scroll bar within a database screen.

Example: To eliminate the amount of displayed records 1. From the menu select an item, for example: District Name.

The list of all the districts is displayed.

2. To eliminate the amount of displayed districts, in the area to the right of the menu, enter a string of letters that are relevant to the required district.

3. Click Search.

Page 20 of 63 20110208-BOSID-UG

1.3.4. Procedure General Flowchart

, –Knowledge Documentation, Old Vs. New

Old New

) Industrial Procedure (Including Photography)

3.1.11

1. )(

2. -BID

3. -BID

4. .

. .

) Industrial Procedure (Including Photography)

1.4.2

.1 -ORS.

2. .

3.

–Internet Site User Guide

' ,4 ,2 ,71700; :2116064 072; :davar.co.ilteam@ha

7

4. . .

. 5000 ; , .

1. , .

, , ) ,.

2 .

3 .

4 .

5 . /

– A5 Technical Translation (A5 page)

7

, , , .

,

WEEE Waste Electrical and Electronic Equipment)(

.

.' ,

,

– Technical Translation – Two Column Page

4

2.

,ACC ON , ,.

) ,3

(.

, ,

BACK TO MAIN MENU.

,VOL

,MUTE

,LOUD

PIP PIP PIP

)Picture–In–Picture .( DVD

(DVD/BLUETOOTH/NAVIGATION).

3. )

:

,

,

.

) ,10 ( . ,

,.

cat.com-www.elad —1

-Recipee Design

,

100 290 190

3 200

2

) ,

(

.1

: 100 290 190

2. 3 ( )

3. 4.

5. :

200 ' 2

6.

– Marcom Translation

Shirley Yardeni – Technical Writer and Translator (Heb./Eng.) (08) 9707-631 | (052) 4816-240 [email protected] | http://www.syc-twriting.co.il/

Hebrew/English Technical Writer and Translator, experienced in the high-tech and low-tech industries. Practiced in writing, editing and designing diverse documents including: Manuals, user/installation/reference

guides, release notes, adapting and integrating graphic elements. Proficient in MS Word and Power Point, experienced in preparing tutorials for customers and employees. Created templates and wrote style guides, provided internal support for documentation issues. Unique skill combination: Eng./Heb. proficiency, Technical Writing experience, MS Word professional, ability to

manipulate graphical elements. Professional Experience 2010-now Freelance (SYC Documentation) Eng./Heb. Technical Writer/Translator

Writing and upgrading user guides, presentations for software, hardware, machines and instruments. Translating diverse appliance user guides, internet sites, working orders, CVs and more. Projects include:

Pazgas – Produced a document summarizing 30 years of firm technical knowledge. HP – Documented (including photos) the assembly process of a printing machine. Xerox – Technical translations/formatting of user manuals for printing/copying/scanning machines. Water purification firm – Wrote and designed a print-ready product page (content and graphics).

2008-2009 Technical Writer (Eng. / Word) | I.D.I. IDIT Technologies (Insurance Software Solutions) Constructed a methodology for generating Runbooks (file repository and installation procedure) for

various configurations and clients (Word simulating FM book-file). Designed/implemented a filename format and file structure, wrote a Style Guide and created Word

Templates. Wrote Release Notes. Provided Word support to employees.

2007 Technical Writer - System Analysts’ Course | Clal-BIT Insurance Company Compiled/edited professional raw material (in various formats) and prepared PPT presentations. Arranged/transferred the entire material to the course site.

2007 Technical Writer – Machine Assembly Documentation | NUR MacroPrinters Photographed and documented the printer assembling procedure. Created Word templates for assembly manuals. Worked closely with mechanical engineers and production floor workers to learn the processes.

2005-2007 Technical Writer (Heb./Eng./Word) | CTWARE— Contact Centers Wrote and edited: Manuals, Release Notes, Product Descriptions / Requirements. Designed, created and assimilated templates: FrameMaker, Word, and PowerPoint. Created Content Structures: Release Notes, High Level Design, Product Requirements. Doc. Library: Arranged a documentation library (catalogue numbers and filename format).

1999-2004 Technical Writer (Eng./FM) | EMC2>Diligent (Storage systems) Wrote White Papers, Manuals, Release Notes and PPT courses. Created templates: FrameMaker, Word, and PowerPoint.

Previous Experience Comverse: Developed, produced and packaged upgrade/installation procedures for new software versions. Edunetics: International Technical Support. Prepared a master demo computer for the Israeli Ministry of Education tender for computerizing schools. Prepared (and won) a bid for the Turkish education market Computer Skills: Word, Trados, PowerPoint, Photoshop, FrameMaker, Adobe Acrobat, Paint Shop Pro, Visio, Languages: Hebrew and English – At mother tongue level

Education: Microtype FrameMaker courses: Basic, Advanced, Template and Index

New Orleans: Documentation Managers Seminar Sivan: COBOL Technion, Haifa: Practical Civil Engineer

15 2012

: '

2011 , '

,30 ,

, , ,

, .

,

- ,

2102ינואר

ביירון חברת של טכנית עריכה שירותי על המלצה: הנדון

סולריות מערכות של ותחזוקה הקמה, בתכנון הניסיון ועתירות המובילות מהחברותהינה סולארית אנרגיה ענבר חברת

.מקצועיים טכניים כתבים י"ע תיעוד תהליכי דורשות שלנו המערכות. בישראל

. עבריתה בשפהמכים למספר מס טכנית עריכה שירותי לנו סיפקה ביירון חברתשירלי ירדני מ

. כללי באופן החברה מול ומההתקשרות בעבורנו שערכה המסמכים מרמת מרוצים אנו

לצרכי עריכת מסמכים טכניים. ביירוןחברת על ממליצים אנו

,בברכה

ענת שני

מנהלת השיווק

ענבר אנרגיה סולרית

,514523836 4 ,2 71707 :2116063/4 - 072 :2406902 - 073 [email protected]

www.markedo.co.il

1 1

28/02/2012

:

–

www.hadavar.co.il

) Quickstart Guide.(

.

,

,

–

4 ,2 71700

:08-9757977

[email protected] www.markedo.co.il

,

/

Thank you for your attention, I will be happy to cooperate with you

Shirley Yardeni Technical Writing and Translations

English/Hebrew

. 08-9707631Tel. : 052-481-6240Mobile:

": [email protected] : Email : Site: http://www.syc-twriting.co.il