The mar­ket­ing exec­u­tives, sys­tem archi­tects and the project engi­neers play a key role in the func­tion­ing of an appli­ca­tion. Based on the sug­ges­tions made by the mar­ket­ing exec­u­tives, the sys­tem archi­tect pre­pares the required strat­egy, fol­lowed by the project engi­neer imple­ment­ing the plan, and goes to the test­ing sec­tion of the com­pany for approval. Any prod­uct gets approved, only if it has the proper chan­nel to reach out to the most of its audience.

For a prod­uct to be suc­cess­ful it is impor­tant to have an appro­pri­ate means of com­mu­ni­ca­tion. One of the means through which a prod­uct can draw the at most atten­tion of the audi­ence is the doc­u­men­ta­tion. Here begins the role of a tech­ni­cal writer and the SME (Sub­ject mat­ter expert).

The SMEs (sub­ject mat­ter experts) act as the main source of infor­ma­tion for the doc­u­ments to be pre­pared as they are well versed with the prod­uct functionality.

It is the prime respon­si­bil­ity of a tech writer to extract as much infor­ma­tion as possible.

Role of SME:

  • SMEs ini­ti­ate the devel­op­ment process of a prod­uct in a company
  • They may be Engi­neers, pro­gram­mers, devel­op­ers, oper­a­tors, clerk and cus­tomer sup­port personnel
  • In a soft­ware com­pany the SMEs are the pri­mary users of the prod­uct, this enables them under­stand the nature, and all other func­tions of a product
  • They pos­sess all the infor­ma­tion such as the aim of this prod­uct, and how to use it, if not all these, at least what the prod­uct is expected to do
  • They pro­vide all the raw mate­r­ial required for the devel­op­ment process, it includes, the sys­tem require­ments, the man­ner of exe­cu­tion, the prob­lems in the process of its design, and the prob­lems that can be solved with the help of this product
  • The SME with the help of the Func­tional analyst(FA) gives the heads-up on the prod­uct to the doc­u­men­ta­tion team

Role of Tech­ni­cal Writer

  • Tech­ni­cal Writ­ers need to be tact­ful enough and pose rel­e­vant questions(like how, why, where, when etc..) to derive all the infor­ma­tion from the SMEs
  • With the help of such ques­tions, the tech writer will be able to extract as much infor­ma­tion as possible
  • In this process of gath­er­ing infor­ma­tion a TW might have to inter­act with var­i­ous SME’s to ful­fill the require­ment of the document
  • Based on all the infor­ma­tion given by the SMEs, the first draft is pre­pared and reviewed by peer Tech­ni­cal Writ­ers. This helps them pre­vent lot of gram­mat­i­cal errors
  • It is then sent to the SME for fur­ther review, based on that feed­back the sec­ond ver­sion is pre­pared with the modifications
  • This way a final ver­sion is cre­ated and released for publication

Con­clu­sion:

Besides the mar­ket­ing team, sys­tem archi­tect, project engi­neer, and the test­ing team, the SMEs play a very cru­cial role in releas­ing the designed prod­uct along with its documentation

Share