Writing Catalog 3

T e c h n i c a l & B u s i n e s s

W r i t i n g S e r v i c e s

Ky

ril

Ja

rd

inic

o

CONTENTS

INTRODUCTION

PROFESSIONAL

APPROACH

SKILLS and

EXPERTISE

FEATURES:

What to Expect

SAMPLES: Instructional

Manual, White Paper,

and Article

CONTACT

INFORMATION

REFERENCES and

IMAGE CREDITS

[email protected]

Visit the Portfolio at www.facebook.com/Kyril1

T o O r d e r , C a l l : 1 8 0 0 . 0 0 0 . 0 0 0 0

P a g e 2

Who is Kyril Jardinico?K yr il J a r d in ic o i s a ta l e nt e d t ec hn ic a l & b us in e s s w r i t er w it h ov e r ei g h t

yea r s of e xp e ri e n ce i n t he f i na n ci a l in d u s t ry . H is s e rv ic e h a s b e e n

va l ua bl e t o c om pa n i e s s uc h a s C IT , p o p ula r m or t ga g e , ba nc o p o p u la r , a n d

Ti tl e R e s o ur c e G ro u p .

B ut m o r e i m p or ta ntl y , K yr il ’ s va l u e p ro p o si t io n —h i s a p p ro a c h t o w r i t ing — is

si mi la r t o a n a r ch e r ’ s a pp r oa ch t o hi s g oa l : ma k e s ur e t ha t ev e r y w or d ,

ev e ry s e nt e nc e , a nd ev e ry pa ra gra p h i s cl ea r , a cc u ra t e a n d on ta rg e t .

What kind of service does Kyril Jardinico Provide?K yr il p ro v i d es a b u si n es s & t e ch ni c a l w ri t ing s e r vi c e t ha t s p ec ia l iz es in

f ina nc e , ba nk in g , a n d a cc o u nt in g p ro j ec t s .

d oc u m en t c om pa n y p ol ic i e s a n d pr o ce d u r e s

Cr ea t e ma n u a l s a nd tra in in g ma t er ia l s

s er v e a s l ia i so n b e tw e en I T a n d ma na g e me n t

R es e a r c h , a sk p r o bi ng q u e st i on s , a n d i d e n tif y g a p s in t h e w o rk f l ow

pr o c es s

pr o vi d e c on t en t t o s oc ia l m e d ia a v en u e s s uc h a s L in ke d I n a n d Fa ce b o ok

The benefits of Kyril Jardinico’s Services?There are numerous benefits of having Kyril Jardinico at your service:

clearer internal communications

reduced support costs

improved sales as a result of accessibility to easily-referenced product information

effective training tools

errors and gaps in a company's disaster recovery plan are revealed and corrected

I N T R O D U C T I O N


P a g e 3

C a t a l o g t i t l eC a t a l o g S u b t i t l e

A Technical Approach to

writingKnowledge can be divided into two categories:propositional and procedural. Propositionalknowledge are statements of fact such as “humansare mammals.” Procedural knowledge is adescription on how to do something, a sequenceof instructions to achieve a goal. Kyril Jardinicohas a commitment to the meticulousdocumentation of those procedures using thethree C’s of writing: Clear. Clarity entails the simple use of

language and the organizing of information ina sensible order.

Concise. This ‘C’ is important because mostusers just skim technical documents.Therefore, a technical writer must turn hugeamounts of data into smaller portions ofinformation that can be used easily.

Correct. Inaccurate information andmechanical errors are not only detrimental tothe integrity of the text, but they also causedamage to the overall technical project. Atechnical writer must verify all pieces ofinformation with SMEs, double check allcontents, and proofread every page.

Careful care must be given in describing procedures. Certain

procedures, such as performing CPRs, can be life saving.

Relationships with

Subject Matter ExpertsA sub jec t mat ter exper t ’ s t ime andknowledge ar e va luab l e . And inorder to have a pro fes s iona l r e l a -t ionsh ip wi th SMEs , Kyr i l J a rd in icoi s commit ted to the fo l lowing : Acqu i r ing as much techn ica l

knowledge of the mater i a l dur ingpreproduct ion

P r e p a r i n g q u e s t i o n s b e f o r ecommun ica t ing wi th SMEs

Be ing an act i ve l i s t ener and apar t i c ipan t in the o rder ing ofprocedur es

C r e a t i n g a s m a n y v i s u a lr epres ent a t ions dur ing the br a in -s torming process so that theSME’s v i s ion i s in sync wi th thetechn i ca l wr i t e r ’ s in t e rpre t a t ion

G i v ing SMEs the f ina l au thor i t yon how the procedur e i s to beper formed

SMEs provide the direction where the writer needs to go.

Creating a Good

presentationThe f ina l produc t of a techn ica l wr i t e r

i s the pr esen ta t ion . Kyr i l J a rd in i co

fo l lows an ef f ec t ive method of cr ea t ing

presen ta t ions tha t us e r s wi l l f ind usefu l

and ins t ruct ive :

Have a c lear purpose .

Know the t arget aud i ence .

Consu l t the SME to cr ea te a so l id

s t ructur e .

Bas e the r esear ch on that s t r ucture .

Avo id in adequa t e o r i r r e l evan t

in format ion .

Inc lude compe l l i ng v i sua l s .

Rewr i t e as many t imes as poss ib le

unt i l the pres ent a t ion i s c le ar ,

conc i se and cor r ec t .

The technical writer must produce commanding and

authoritative presentation.

PROFESSIONAL APPROACH

Visit the Portfolio at

www.facebook.com/Kyril1

T o O r d e r , C a l l : 1 8 0 0 . 0 0 0 . 0 0 0 0

P a g e 4

P R O F E S S I O N A L

A C A D E M I C

C O M P U T E R

BANKING: retail & online banking, saving & checking accounts, CDs, money markets,

account discrepancies, ATM and debit access devices, and customer onboarding.

MORTGAGES: collections, post-closing, refinance, HUD-1, settlements, adjustable rate

mortgages, FHA loans, and short sale.

REAL ESTATE: title insurance, land & surveys, easements, liens, encroachments, trusts,

deeds, public records, power of attorney, the closing process, and RESPA .

CONSUMER FINANCE: personal loans, HELOC, foreclosure, bankruptcy, payoffs,underwriting, credit history, interest rates, amortization, and appraisals.

ESCROW: premium disbursements, insurance products (homeowner’s, flood, & wind),

and taxes.

ACCOUNTING: fundamentals, accrual accounting procedures, accounting systems, closing

activities, and auditing.

BUDGETING: creating & analyzing an operating budget, effective budget management,

and master budgets.

FINANCIAL MANAGEMENT: cost accounting decisions, strategic management, and risk

management.

FINANCIAL ANALYSIS: principles of financial statements, common size statements,

trend analysis, common size ratios, and forecasting.

BUDGET ACCOUNTING: sales and accounts receivable, cost of goods sold, expense &

inventory, operating expenses & prepaid expenses, depreciation & fixed assets, accumulated

depreciation, accounts payable, operating expenses, accrued liabilities, interest expense,

income tax expense, income tax payable, net income, and retained earnings.

ADOBE: InDesign, FrameMaker, RoboHelp, and PhotoShop.

MICROSOFT: Excel, Access, Word, PowerPoint, and Visio.

SK

IL

LS

an

dE

XP

ER

TI

SE


P a g e 5


A Solid Foundation: The Users are the Starting PointThe users are the starting point for the assumptions that the technical writer wants to

make about inherent skills and perceptions. Therefore, Kyril Jardinico will interact

with the users and solicit as much feedback as he can gather. He has a duty to know all

of the strengths, weaknesses, frustrations, and experiences relating to the end product.

Furthermore, he will have an open-door policy where users are encouraged to provide

their feedback to him in the form of letters, e-mails, telephone calls, and social media

tools. And the more information he can gather from users, the better his perspective

will be in producing quality documentation.

F E A T U R E S : What to Expect


Kyril Jardinico will interact with the

users and solicit as much

information as he can gather. He will

have an open-door policy where

users are welcome to provide their

feedback to him using

communication tools such as

letters, e-mails, telephone calls, and

social media avenues.

T o O r d e r , C a l l : 1 8 0 0 . 0 0 0 . 0 0 0 0

P a g e 6

A Solid Foundation: Interaction with the UserSince Kyril Jardinico will spend a considerable amount of time interacting with

users, he will also represent their perspective to management. In this role, he is

interested in identifying the limitations or deficiencies of the product. He will also

research from other departments in order to improve from those limitations and

correct any deficiencies. This role is important because it allows Kyril to contribute

to discussions that can render innovation, improve a procedure, and enhance the

safeness of the product.



Kyril Jardinico’s interaction with the

users will be helpful in rendering

innovation, improving a procedure,

and enhancing the safeness of a

product.

P a g e 7


A Solid Foundation: A Commitment to a

Code of EthicsAs the technical writer, Kyril Jardinico will observe the highest

ethical and professional conduct:

1. Accept responsibility for his work

2. Protect the intellectual property of his employers and clients

3. Avoid real and perceived conflicts of interest whenever

possible; disclose the conflicts of interest to affected parties

when they do exist

4. Properly credit the contributions of others.

5. Honor both verbal and written agreements

6. Maintain and improve his technical competence

7. Undertake documentation tasks only if qualified by training

and after a full disclosure of pertinent limitations

8. Seek, accept, and offer honest criticism

9. Acknowledge and correct errors

10. Assist colleagues and coworkers in their professional

development and to help them in following this code of ethics

*Taken from Svi Ben-Elya’s “Code of Ethics.”



Kyril Jardinico will observe the highest

ethical and professional conduct.

T o O r d e r , C a l l : 1 8 0 0 . 0 0 0 . 0 0 0 0

P a g e 8

The Manuscript: A Clear, Crisp and Clean Writing StyleKyril Jardinico will produce clear, clean, and crisp manuscripts. His style can be summed up by the following:

Vigorous writing is concise. A sentence should contain no unnecessary words, a paragraph no unnecessary sentences, for the same reason that a

drawing should have no unnecessary lines and a machine no unnecessary parts. This requires not that the writer make all his sentences short,

or that he avoid all detail and treat his subjects only in outline, but that every word tell.

— Elementary Principles of Composition, William Strunk (1918). The Elements of Style


The opposite—a fuzzy, wordy, and disorderly manuscript—can result in the production of a defective product and can

also compromise the integrity of the company to its customers.

Visit the Portfolio at


Kyril Jardinico’s writing style

can be characterized as using

the simplest words to convey

the most complex ideas.

P a g e 9


The Manuscript: Use of FlowchartsKyril Jardinico will ensure that users immediately capture the process flow at a single

glance. He will use flowcharts because of its applicability to large-scale projects and

low-level work instructions. Flowcharts can help management analyze the procedures

and look for inefficiencies in the work process. Moreover, flowcharts can also take

the form of Decision Trees that filter the number of possible solutions based on a

series of categories. Decision Trees also make excellent troubleshooting guides.

Finally, business procedures may also be subject to regulatory requirements; and

flowcharts can aid in the easier documentation of such procedures.



Flowcharts are applicable to both

large-scale and low-level work

instructions. Business procedures

may also be subject to regulatory

requirements; and flowcharts can

aid in the easier documentation of

such procedures.

An example of a Decision Tree.

T o O r d e r , C a l l : 1 8 0 0 . 0 0 0 . 0 0 0 0

P a g e 10

The Manuscript: Having a Clear Objective in

the DocumentationWhen a driver is going to an unfamiliar place, it is not only important

that he/she be provided with directions, but he/she must also know the

specific destination. For example, a driver from Philadelphia must know

that Tampa is the final destination on that specific trip. More important-

ly, the driver must know why he/she is going to Tampa. In documenta-

tion, Kyril Jardinico will not only provide the user with a clear descrip-

tion of the objective but he will also describe the purpose of that same

objective. For instance, if he is going to write a procedure on forecasting

using Excel, he will identify the purpose of forecasting—the tool that

companies use to know their financial position in the future. This de-

scription is important because users are now given the chance to contrib-

ute to the process and, perhaps, come up with more efficient methods

that they can add to the instructions. After all, there is more than one

way to get from Philadelphia to Tampa; and there are multiple ways to

solve a problem. Users are now given a chance to produce better solu-

tions.



Having a clear objective allows users to

contribute to the process and, as a result,

they can come up with more efficient

methods that they can add to the

instructions.

P a g e 11


Use of Social Media: User FeedbackIf soliciting user feedback is an objective, then social media websites such

as Facebook provide a great opportunity to gather such information.

Naturally, private settings first need to be set. And once that is

implemented, Kyril Jardinico is now given the chance to peruse user

comments, opinions, and suggestions while maintaining confidentiality.

The user can ask questions, which Kyril will research for the answer. But

the most important feature of this tool is the ability for Kyril to post

documentation in the website as if it were a note or a blog. This posting

will allow users and management to see his work in progress allowing for

early feedback and detection of errors in the documentation drafts.



Social media allows users and

management to see Kyril’s assignment

in progress allowing for constructive

feedback and early detection of errors.

T o O r d e r , C a l l : 1 8 0 0 . 0 0 0 . 0 0 0 0

P a g e 12

Use of Social Media: Real-Time

UpdatesManagement has the right to know the progress and direction

of its employees. Therefore, Kyril Jardinico will inform them of

his progress in real time using microblogging websites such as

Twitter. He will update the management team of the tasks that

have been completed so that they can monitor his work and

ensure that it is on schedule. Kyril can also benefit from this tool

because it allows him to see his own progress.



ASSIGNMENT COMPLETE…

10:30 AM

Microblogging websites, such as

Twitter, allow management to monitor

Kyril Jardinico’s progress and ensure

that projects are on schedule.

P a g e 13


Use of Social Media: Constant ImprovementsThe French poet and critic Paul Valery once said that “a poem is never

finished, [it is] only abandoned.” In technical writing, documentation is also

never finished even after the completion of an end product: there is always

room for improvements, amendments, and corrections. Kyril Jardinico is

committed to constant rewrites and revisions of his documents. And since

social media websites allow users to comment on the documentation even

after if it is complete, he will review upcoming feedbacks and respond to

any suggestions. The overall goal for him is to produce documents that

constantly get better and meet the changes in technology.



Kyril Jardinico will use social media

to help him produce documents that

constantly get better and meet the

changes in technology.

T o O r d e r , C a l l : 1 8 0 0 . 0 0 0 . 0 0 0 0

P a g e 14

S A M P L E : Instructional Manual

P a g e 15

C a t a l o g t i t l eC a t a l o g S u b t i t l eS A M P L E : White Paper

T o O r d e r , C a l l : 1 8 0 0 . 0 0 0 . 0 0 0 0

P a g e 16

S A M P L E : Article

P a g e 17


In need of a Technical & Business

Writer?

Contact Information:

[email protected]

Visit the Portfolio at:


C O N T A C T I N F O R M A T I O N

Every word, every sentence, and

every paragraph will be clear,

accurate, and on target.

T o O r d e r , C a l l : 1 8 0 0 . 0 0 0 . 0 0 0 0

P a g e 18

References

Books

Strunk, W., & White, E. (1918). The elements of style. (4th ed.). New York City: Pearson.

Online Articles and Blogs

Ben-Elya, S. (2008, January 20). [Web log message]. Retrieved from http://elephant.org.il/about_us/elephant_org_il_code_of_ethics.html

Hebb, N. [Web log message]. Retrieved from http://www.breezetree.com/articles/what-is-a-flow-chart.htm

Johnson, T. (2012, June 21). [Web log message]. Retrieved from http://idratherbewriting.com/2012/06/21/writing-user-centered-documentation-or-my-best-days-as-a-technical-writer/

Online Discussion

Candelario, A. (2012, June 29). What makes an effective procedures writer? [Online forum comment]. Retrieved from http://www.linkedin.com/groups/What-makes-effective-procedures-writer-1086137.S.129042004?

qid=f325953c-4b71-4dd0-b555-1f3e17389ffe&trk=group_items_see_more-0-b-ttl

Image Credits

Boobaloo. (Artist). (2009). Three red drops swirl.. [Web Drawing]. Retrieved from http://openclipart.org/detail/26899

(2012). Archery target.. (2012). [Web Drawing]. Retrieved from http://bestwall4u.blogspot.com/2012/01/3d-wallpaper.html

Miller, A. (Artist). (2010). Cpr. [Web Drawing]. Retrieved from http://blogs.redcross.org.uk/tag/cpr/

(2007). Shutterstock image/. (2007). [Web Drawing]. Retrieved from http://wiredprworks.com/branding/publicity/linkedin-pr-top-10-ways-to-become-a-subject-matter-expert/

(2010). Public speaking. (2010). [Web Drawing]. Retrieved from http://post.career.vi/2010/06/mastering-the-art-of-public-speaking/

(2012). Manual. (2012). [Web Drawing]. Retrieved from http://chromservis.cz/item/hplc-troubleshooting

(2012). Diploma. (2012). [Web Drawing]. Retrieved from http://www.mycertifiedtranslations.com/our-certified-translation-services/diploma-translation/

(2012). Laptop cartoon. (2012). [Web Drawing]. Retrieved from http://www.doctorlaptop-repair-jack.com/

Zwilling, M. (Artist). (2012). View from the customer. [Web Drawing]. Retrieved from http://blog.startupprofessionals.com/2012/03/get-view-from-customer-to-close-sales.html

(2012). Presentation skills. (2012). [Web Drawing]. Retrieved from http://www.newhorizons.jo/courses/Soft-Skils/adv-pres-skill.aspx

(2012). Ethics road sign. (2012). [Web Drawing]. Retrieved from homesteadishome.blogsport.com

(2008). Decision tree. (2008). [Web Drawing=. Retrieved from http://www.bennorthrop.com/Home/Blog/2008_01_20_decision_tree.php

(2011). Direction. (2011). [Web Drawing]. Retrieved from http://jobs-spot.net/2011/08

(2012). Social media. (2012). [Web Drawing]. Retrieved from http://heatherfountaine.wordpress.com/2012/03/04/social-media-its-an-adventure/

(2010). Cute file icon. (2012) [Web Drawing]. Retrieved from http://www.freeiconsweb.com/Free-Downloads.asp?id=547

(2012). Person question. (2012). [Web Drawing]. Retrieved from http://www.leapgo.com/Portals/129374/images/blog/person-question-300x300.jpg

(2010). Twitter bird. (2010). [Web Drawing]. Retrieved from http://gigaisland.com/?p=1778

Writing Catalog 3

Business

web log message

social media

social media

jardinicohotmail

technical

web drawing

kyril jardinico

solid foundation