Reuters Tech Writing May 10-12, 2006. Introduction Congratulation Writing Quality Documentation Tips Technical Writers Checklist Quizz Reuters Technical. - презентация

1 Reuters Tech Writing May 10-12, 2006

2 Introduction Congratulation Writing Quality Documentation Tips Technical Writers Checklist Quizz Reuters Technical Writing

3 Reuters Technical Writing - Introduction A reputation built on accuracy, reliability and speed Millions of consumers see and hear news from Reuters in the world's media and some 330,000 financial market professionals across the globe each day also rely on Reuters services to provide them with the information and tools they need to help them be more productive. Reuters drives decision making worldwide. We are the largest financial information provider in the world. Why? Because people trust our information. These values are shared and upheld across the board by each team, reporters and technical writers alike.

4 Congratulation First Goal achieved XMS online help meeting Reuters quality standards delivered without exceeding 60% of the time that would have been required by a team of in-house writers. Well done! and keep the good work. There has been significant improvements over the past months: Increased compliance to RFS documentation style guidelines Increased reactivity and thoroughness in integrating RFS feedback The number of rephrasing due to a poor level of English has significantly decreased. Remaining Issues: Up to 90% of the rewording required is due to inappropriate style and/or information: The text is grammatically correct, but the terminology used and the information given is inappropriate for the target audience. A significant part of the information is still inserted in a descriptive format, rather than processed into user-oriented procedures. The next step is to achieve on-par performance with a team of in-house writers. Our next challenge is to deliver the same level of quality and time performance on Calculators.

5 Writing Quality Documentation There are several indicators for assessing quality technical writing: Accuracy Clarity Readability Added value

6 Writing Quality Documentation - Accuracy Accuracy bears directly on the marketing impact of any paper and helps uphold the companys reputation for high-quality standards. Appropriate vocabulary and a logical structure help communicate your message and lend credibility to your ideas. That credibility is weakened by inaccurate content, typographical errors, misspelled words, incorrect grammar, and inconsistencies in style. Research the financial concepts used in the products that you document Check the accuracy of your content Proofread the text

7 Writing Quality Documentation - Clarity Technical writers make all words, sentences and paragraphs count by removing unnecessary words and undesirable repetition without sacrificing clarity. They avoid using excessive adjectives, adverbs, and intensifiers such as very and quite. They process the resource at their disposal into a logically structured information content, instead of copying and pasting the reference material. They achieve conciseness by eliminating any information which has no added-value from their text and by logically structuring the information.

8 Writing Quality Documentation - Readability Readability The communication of a message is directly related to the clarity and readability of each sentence. Sentence length is one measure of readability because the reader must read, understand, interpret, and remember information sentence by sentence. Correct spelling is another. It reinforces both the clarity and credibility of any document. Misspelled words divert the readers attention away from the message and may cause the writer to appear incompetent, careless and potentially untrustworthy. Therefore, proofread your documents carefully before submitting them.

9 Writing Quality Documentation – Added Value Product knowledge and understanding the financial concepts at work is paramount to writing added-value documentation. Short of that knowledge, technical writers are likely to fall into the pitfall of merely describing the tool in details without explaining how to use them. Writing added-value documentation consists in answering one fundamental question: What can users do with the product? Bringing added-value also entails processing reference material into a structured information content, adapted to the target audience. Avoid copying and pasting reference material, as this material is rarely suited to the users.

10 Tips - Write short sentences - Use the present tense - Use the active voice - Avoid jargon - Proofread all documents before delivering them: Одна́ голова́ хорошо́, а две луч́ше. - When in doubt, always refer to the Reuters Documentation Guidelines

11 Technical Writers Checklist The hallmark of a good writer is to stay focused on its readers. Examine every detail from the readers point of view, then rewrite to sharpen, simplify, and clarify. As you rewrite, ask yourself these questions: - Are my ideas logically ordered from the simple to the complex? - Have I written simple, succinct sentences? - Have I eliminated needless words, especially modifiers? - Have I used verbs in the active rather than passive voice? - Have I avoided shifts in subject, number, verb tense, and voice? - Have I placed subjects close to their verbs? - Have I placed verbs close to their objects? - Have I chosen words that express my meaning precisely? - Have I avoided jargon and clichés? - Have I explained all acronyms? - Have I used correct grammar and punctuation? - Have I proofread for spelling and typographical errors?

12 Quizz Повторе́нье - мать уче́нья

13 How would you edit the following content? You can retrieve news headlines and stories grouped according to the following topics: NAME OF THE COMPANY, for example, ALCATEL in the illustration above, News on the selected Convertible, All Convertible News, Equity Linked News, Equity Linked, New Issues News, Central Bank, Reuters Market Reports, Interest Rates, Political News, All Ratings News, Economic Indicators => Convert to a bullet list

14 How would you edit the following content? Click near to the name of a model, to view its help (without starting the model itself). Click to view the corresponding help without starting the model.

15 How would you edit the following content? In Paid the model displays the type the first leg of the swap. In Paid, the model displays the type the first leg of the swap.

16 How would you edit the following content? A list of all the portfolios you set up. A list of all your portfolios.

17 How would you edit the following content? The model displays in this list all the deals for the portfolio you choose in. This list includes all the deals of the portfolio you choose in.

18 How would you edit the following content? The model displays the details for each deal in this table. This table displays the details of each deal.

19 How would you edit the following content? CDS Portfolio displays the performance of portfolios of currency default swaps in terms of net present value in both dealt currency and base currency terms. CDS Portfolio allows you to analyze the performance of your CDS portfolios in terms of net present value in both dealt and base currencies.

20 How would you edit the following content? Note: The model marks with an asterisk the CDS spreads that are out-of- date and not used. Note: The model marks with an asterisk (*) the CDS spreads that are out- of-date and not used.

21 How would you edit the following content? Apply historical revaluation Revaluate historical CDS

22 How would you edit the following content? view the data as a chart display charts

23 How would you edit the following content? Displays the features of the specific CDS you enter, such as frequency and notional amount. Allows you to enter the details of a CDS, such as frequency and notional amount.

24 How would you edit the following content? The model is reduced to two pages. clear and concise layout

25 How would you edit the following content? - The model now handles quarterly and monthly rolls automatically. - The model closely interacts with CDR Porfolio. - You can retrieve data for a CDS curve from multiple sources. - Users can search tickers, and also use fake tickers and save them. - Users can select a historical date to calculate Mark-To-Market. - The model supports the new field Default Probability. - The model displays Fitch ratings in addition to Standard & Poor and Moody's. -automatic quarterly and monthly rollovers - link to CDS Portfolio to analyze your portfolio - possibility to select a curve source - ticker search and fake ticker functions - historical analysis - default probability calculations - Fitch ratings

26 How would you edit the following content? In Setup, you enter or choose several options that influence the spread curve calculations. In Setup, you can define spread curve calculation parameters.

27 How would you edit the following content? Enter the counterparties in this list. You can use short-codes and abbreviations, and the model auto-fills the cell with counterparty's full name. Enter the counterparties in this list. You can use short-codes and abbreviations. The model auto-fills the cell with the full name of the counterparty.

28 How would you edit the following content? NPV (Net Present Value) is zero, unless you enter an historical CDS for pricing. Net Present Value (NPV) is zero by default. When pricing an historical CDS, the model calculates the historical NPV.

29 How would you edit the following content? This is the first tab in the lower half of the worksheet, which displays additional information relating to the convertible bond. This tab displays additional information relating to the convertible bond.

30 How would you edit the following content? The Bond Holding field shows the number of units held or the nominal value traded according to the quotation mode of the convertible. Bond Holding displays the number of units held or the nominal value traded according to the quotation mode of the convertible.

31 How would you edit the following content? The table columns become as follows: The table displays the following data:

32 How would you edit the following content? If you want to search for a RIC, you can click to access the Reuters Data Search facility. To search for a RIC, click to access the Reuters Data Search facility.

33 How would you edit the following content? To apply the realtime volatility surface published by Intercapital Brokers, you should choose Surface ICAP. To apply the realtime volatility surface published by Intercapital Brokers, choose Surface ICAP.

34 How would you edit the following content? In Setup, you control various parameters of the model. In Setup, you can define various parameters of the model.

35 How would you edit the following content? The model displays the forward matrix for forwards from six months to 20 years (designated as 6M, 1Y, 18M, 2Y, 3Y, 4Y, 5Y, 6Y, 7Y, 8Y, 9Y, 10Y, 11Y, 12Y, 13Y, 14Y, 15Y, and 20Y) and for maturities depending on you choice for Maturity Periods (either from 6M to 8Y or from 9Y to 20Y). The model displays the forward matrix for forwards from 6 months to 20 years and for maturities depending on the period you choose in Maturity Periods.

36 How would you edit the following content? In current positions data area, the model displays the following values: In, the model displays the following values:

37 How would you edit the following content? The value in # Shares to Sell can be changed. You can change the value in # Shares to Sell.

38 How would you edit the following content? The model displays the percentage for each new position of buy or sell. The model displays the percentage for each new buy or sell position.

39 How would you edit the following content? This is a drop-down list that allows you to select a navigation option. This drop-down list allows you to select a navigation option.

40 How would you edit the following content? The model displays the label near as Stock Basket with Portfolio. The model displays Stock Basket with Portfolio.

41 How would you edit the following content? Note: When you choose to navigate to Stock Basket for the complete portfolio, and the portfolio is large, it can take the model too long to open and populate Stock Basket. The same is true for navigating with selected stocks, if the number of the selected stocks is greater than 20. Note: When the number of stocks is greater than 20, it may take a while for the model to open and populate.

42 How would you edit the following content? When a constituent within the portfolio has been partially traded the dividend entitlement clearly changes. When a constituent within the portfolio is partially traded, the dividend entitlement changes.

43 How would you edit the following content? - filter ATs by direction, for example, Only Buys, or Only Crosses, - include or exclude specific sell-side contributors. - filter ATs by direction, for example, Only Buys, or Only Crosses - include or exclude specific sell-side contributors

44 How would you edit the following content? Advertised Trades display in hundreds. The model displays advertised trades in hundreds.

45 How would you edit the following content? Prev moves the analytics view backward to the previously viewed display, and Next moves the view forward to the next analytics display. Click Prev to view the previous analytics display. Click Next to move to the next analytics display.

46 How would you edit the following content? Expired special and natural indications always display in chronological order, and are not included in the active display if you activate Rank by Time. The model displays expired special and natural indications in chronological order, and excludes them from the active display when you activate Rank by Time.

47 How would you edit the following content? Click to open the calendar and choose the day in the calendar: Click to open the calendar and choose a date:

48 How would you edit the following content? Enter up to 15 RICs you require in, separating each RIC with a space. Enter up to 15 RICs in, separating each RIC with a space.

49 How would you edit the following content? For example, BAY.L for British Airways plc, AIRF.PA for Societe Air France, RYA.I for Ryanair Holdings plc, and EZJ.L for Easy Jet plc. For example, BAY.L for British Airways plc.

50 How would you edit the following content? Also you can view the Fenics curve. You can also view the Fenics curve.

51 How would you edit the following content? Viewing rating news from the mpd.compelling-content.com database Viewing rating news

52 How would you edit the following content? Expanding the details area to the whole page and returning to the standard layout of the page Resizing the details area

53 How would you edit the following content? What's New? -You can make cashflow adjustments for each leg of the swap separately. See Swap conventions. -You can enter your own FX spot rate for pricing the swap. See Entering swap basics. -For forward start swaps, you can make cashflow adjustments for each leg of the swap separately. See Enter forward start swaps. -To revalue a historical swap, you can now enter the historical start date in Swap Basics in Main. The section Historic Swap, NPV and CF has been removed. You can view the present value of each leg, the net present value, and the accrued in Main. See Revalue historical swaps. -You can calculate each leg using its own discount factor, and displays the net present value in either currency of the swap. You can enter both swap rates to calculate the net present value. See Change the leg of CBS. -The method for saving swap structures has changed. See Saving currency swap structures. -You can save swaps to up to five portfolios directly from Interest Rate Swap to Swap Portfolio. See Saving your swap in a portfolio. -You can choose swap conventions in Setup. See Swap conventions. -You can now apply your zero curve scenario to the zero curve by entering a basis point adjustment and applying a curve shift to the zero curve. See Adjust the zero curve. What's New? -cashflow adjustments for each leg of the swap separately -custom FX spot rate for pricing the swap -revalue a historical swaps -calculate each leg for a different discount factor -new method for saving swap structures, including saving up to five swaps to Swap Portfolio -choose swap conventions -shift scenario applicable to the zero curve

54