테크니컬 라이터의 고유 능력

테크니컬 라이터(technical writer)는 기술적인 정보를 전달하는 문서를 작성한다. 말 그대로 技術 作家이다. 이들이 다른 저술가들과 어떤 점에서 다른지 살펴 보겠다.

저술과 관련된 일을 하는 사람들이 많다. 조선학 교수는 석유 시추선에 대해, 의학 전문 기자는 메르스에 대해, 서울시의 홍보 담당자는 서울역 고가도로의 공원화에 대해 글을 쓴다. 이런 사람들에 비해 테크니컬 라이터만이 갖고 있는 고유한 능력이 있을까?

글쓰는 사람들은 모름지기, 교열가의 도움을 받는다 해도, 문법과 어법에 대해 상당한 지식을 갖추어야 한다. 그러니 테크니컬 라이터도 당연히 자기가 사용하는 언어를 공부해야 한다. 그러나 다른 이들에 비해 테크니컬 라이터에게 더 높은 수준의 어학 지식이 요구되는 것은 아니다. 그러므로 이 점에서 테크니컬 라이터의 고유한 능력을 찾을 수 없다.

다른 사람들에 비해 테크니컬 라이터는 출판 소프트웨어를 잘 다루어야 한다. 그 능력이 필수적이라고 할 수 없으나 출판 소프트웨어를 잘 다룰수록, 타이포그래피에 대한 식견을 많이 갖출수록 높은 경쟁력을 갖게 된다. 그러나 그것은 “좋은 내용을 작성해야 한다” 본연의 임무와는 거리를 두고 있다. 따라서 이 역시 테크니컬 라이터의 고유 능력이라고 볼 수 없다.

테크니컬 라이터는 글쓰기 방법(writing style)을 알고 있다. “묘사 문장이 20 개 이내의 단어로 이루어지는 것이 이상적이다”라는 것 따위가 그 중 하나이다. 독자의 습성과 편의를 더 많이 고려함으로써 그러한 원칙들이 만들어졌다. 그렇다면 테크니컬 라이팅이 일반적인 글쓰기 방법론과 크게 다르고, 그로부터 테크니컬 라이터의 고유성을 찾을 수 있을까? 이 점이 흔히 크게 강조되지만, 테크니컬 라이팅이 독립적인 영역을 차지할 만큼 특이성을 가졌다고 보기 어렵다. 테크니컬 라이팅 지침과 보통의 글쓰기 교훈 사이에서 차이점들보다는 공통점들이 더 많다.

내용으로 눈을 돌려 보자. 테크니컬 라이터가 작성한 글은 정보를 담고 있다. 학자나 기자가 작성한 것들도 정보를 담고 있다. 그런데 여기에서 약간의 차이가 발견된다. 스마트폰을 소개하는 신문 기사에 비해 그 스마트폰의 사용 설명서는 훨씬 더 많은 것들을 아주 상세하게 다룬다. 매뉴얼이 담고 있는 정보의 양이 훨씬 더 많다고 할 수 있다. 그런데 학술서나 논문과 비교하면 덜 전문적이다.

테크니컬 라이터에게 주어지는 특이한 상황은 “잘 알지 못하는 것에 대해 독자에게 필요한 만큼 상세하게 설명해야 한다“는 것이다. 테크니컬 라이터가 전직 엔지니어라고 해도 이 상황은 별로 달라지지 않는다.  한 명의 개발자가 다 설명할 수 있을 만큼 단순한 제품은 그다지 많지 않다. 그리고  깊이 알고 있기 때문에, 필요 이상으로 장황하게 또는 어렵게 설명한다면 그 지식이 도리어 독이 될 수 있다.

테크니컬 라이터를 번역사에 비유할 수 있다. 번역사가 한국어 글을 외국인이 이해할 수 있게 영어로 옮기듯이, 테크니컬 라이터는 엔지니어의 말을 독자가 이해할 수 있는 말로 옮긴다. 번역사가 내용을 제대로 이해하지 못하면 오역하듯이, 테크니컬 라이터가 자신이 작성하고 있는 제품이나 그와 관련된 기술을 올바르게 이해하지 못하면, 독자에게 필요한 정보를 제공하지 못하거나 독자를 이해시키지 못한다.

여기에서 테크니컬 라이터의 고유 능력을 찾을 수 있다.

테크니컬 라이터는 빨리 배워야 한다.  엔지니어가 제공하는 자료나 구두 설명에서 헛점이나 모순을 빨리 짚어내어 되물어야 한다. 모든 것을 엔지니어에게 의존할 수 없기 때문에 인터넷에서 관련 지식을 배워야 한다. 구글이 보여주는 검색 결과들을 빨리 읽고 이해해야 한다.

테크니컬 라이터는 정보의 필터가 되어야 한다.  엔지니어들이 중요하게 여기는 것들 가운데 어떤 것들은 독자에게 필요하지 않거나 혼란을 줄 수 있다. 테크니컬 라이터는 주어진 정보들을 선별하여 어떤 것들을 독자에게 제공할지 적절하게 결정해야 한다.

 

What’s the big deal with XML?

XML (eXtensible Markup Language) is one of those initialisms that remains in the background of the tech industry. It pops up in almost every major office software suite (did you ever wonder what the x stands for in .docx?). It shows up all the websites that use XHTML (about 34% of the websites out there) and each RSS feed that you read. And, if you know any technical writers, they probably won’t shut up about DITA (Darwin Information Typing Architecture).

So, what makes XML so special? Well, the answer depends on who you are and how you use XML. Writers like XML because it gives them full control of their text. Developers like XML because they can easily repurpose content. And, designers like it because they can apply stylistic changes on the fly. But, before we explain these benefits in too much detail, we should probably explain what XML is.

What is XML?

XML stands for eXtensible Markup Language. Like HTML, XML is a markup language. Markup is the information that tells a computer how to read content, such as text. For example, this website uses HTML markup (actually, a combination of HTML, CSS, PHP, and Markdown) to tell your web browser where to display text, what font to use, and when to display a word in bold. Without some sort of markup, it would be almost impossible for your computer to properly display content in web browsers, desktop publishing programs, or even applications like games.

Unlike HTML, XML focuses on what the data is rather than how the data looks. That is, the markup in XML tells the computer the content type, and a separate style sheet tells the computer how to display the content. In HTML, the markup only tells the computer how to display the content. So, if you want to change the font in all of the headings on your HTML webpage, you have to change each one individually. In XML, you can simply change the entry that specifies the heading font in the style sheet.

Another notable difference is that XML doesn’t use predefined tags (tags are units of markup). HTML markup is the same everywhere. So, if you use an <h1> tag in HTML, an HTML reader automatically knows that it is a top-level heading. In XML, a style sheet is needed to define the tag, but you can also name the tag anything you want. For example, you could name it <section_heading>, <page_heading>, or even <the_only_heading_you_will_ever_need>. This is what puts the eXtensible in eXtensible Markup Language (XML), and you can create as many tags as you want – which means that you can make your content as nuanced or lightweight as you need.

So, why is XML so great?

Extensibility

XML emerged as a response to the inflexibility and inefficiency of HTML. The standard on which XML is based, SGML (Standard Generalized Markup Language), was deemed too complex, so XML was made to simplify it. XML ditches the unnecessary elements of SGML while still retaining the key principles that the markup needs to describe the content. By abandoning predetermined tags and unnecessary elements and allowing content creators the flexibility to create their own tags, XML offers a lightweight and flexible solution for transporting information, especially text.

Extensibility also makes XML easier to use and maintain than other markup languages. Authors can intuitively name tags based on their functions. Consider the following example.

< ?xml version="1.0" encoding="UTF-8"?> 


  
    Dear Mr. Hughes,
  
  
    I so enjoyed your last film and do hope that you make another.
  

Based on the names used in the tags, you can infer the basic structure of the document and the type of content that each tag contains. Furthermore, you or a new employee could return to this document several years down the road and still figure out what the tags mean.

Strictness

XML is also far stricter than HTML. The rigid syntax required by XML results in smaller, faster, and lighter browsers. For example, XML is stricter than HTML in the following cases:

  • Case sensitivity: HTML is not case sensitive, while XML is.
    A <Paragraph> tag is not the same as a <paragraph> tag.

  • End tags: HTML lets you get away with not closing elements, while XML doesn’t.
    A <p> tag won’t work without the corresponding end tag (</p>).

  • Quotation marks: HTML lets you use value delimiters without quotation marks, while XML doesn’t.
    <object width=100> won’t work, but <object width=”100”> will.

  • Nesting: HTML lets you overlap elements, while XML doesn’t.
    <b><i>Cattle</b></i> won’t work, but <b><i>Cattle</i></b>.

In the past, some Internet browsers devoted up to 50% of their code to correct the mistakes or inconsistencies in HTML content. By imposing a more rigid set of rules, browsers and other programs that process text (often called parsers) no longer need to account for mistakes in the markup. Paying a little more attention when writing is a small price to pay for better overall performance.

In addition to being strict about syntax, XML can also include rules about the structure of your documents. For example, if you were creating an employee database, you could create an <employee> element that must contain <first_name> and <last_name> elements. Doing so ensures that the required information is included and that all unnecessary information, such as an employee number, is excluded.

Easy Data Exchange

Although extensibility and simplicity added to its early success, XML’s greatest claim to fame is that it allows authors to easily publish the same content to different media. Because XML concentrates only on the content type, the content remains independent of the medium. So, authors can write and edit a document in XML and publish it to a website, user’s manual, and helpdesk script. This facet of the XML is often touted as single-source – multi-target. In fact, content reuse has catapulted DITA, an XML standard maintained by OASIS Technical Committee, to the forefront of the technical writing world.

Furthermore, XML relies on free open standards, such as the XML 1.0 Specification, so it avoids the bulk, complexity, and inaccessibility of propriety data formats, such as those used in the older versions of desktop publishing applications like Word. XML content and markup is stored as text that authors can configure directly. Even when using an XML editor, such as FrameMaker, authors can still output the XML text to make changes or transfer the content to another format.

Conclusion

So, back to the question at hand: What makes XML so special? Well, it’s right there in the name: extensibility. Writers and developers are constantly finding new ways to use XML to accomplish their goals in a variety of media formats, and XML supports the freedom they need to do it. That, coupled with its ability to be intuitive and strict in both code and structure and easily distributed to multiple channels means that XML will continue to be a staple of the IT community for years to come.