Year in Review: My First Year as a Technical Writer

Filed Under: Blogging, Documentation & Help Manuals, Job Skills & Requirements, LabVIEW & Toolkits, Lists, National Instruments, Software & Tools, Technical Communication/Writing
3222 visits, 8 today

The views expressed on this website/weblog are mine alone and do not necessarily reflect the views of my employer.

Today’s my one year anniversary working at National Instruments. I work in the China R&D center in Shanghai as a technical writer. My job is to write documentation for LabVIEW and LabVIEW add-ons.

My first few weeks at NI were spent in training. Never in my working years have I experienced such rigorous training. Everything I need to know about technical writing at NI was crammed into my head over the course of several weeks. Then I worked on a few projects, met a few developers, learned a few tools, worked on a few projects, wrote a few help topics, attended a few parties, ate lots of stuff, and one year later, I’m writing this article.

100 Things I’ve Learned, Accomplished, and Done

  1. I started this blog about my life as a technical writer at NI Shanghai.
  2. I learned HTML.
  3. I learned the basics of CSS.
  4. I learned XML.
  5. I learned how to use Altova XMLSpy.
  6. I attended a three-day LabVIEW Basics I course.
  7. I learned how to use LabVIEW.
  8. I learned how to use a bunch of LabVIEW tools we created for documentation tasks.
  9. I created a tool in LabVIEW to automate the process of copying compiled help files from server to local computer.
  10. I learned how to use Adobe FrameMaker.
  11. I learned how to convert documents to PDF format.
  12. I read through all our internal style guides — NI Style Guide, LabVIEW Style Guide, and LabVIEW documentation user guide.
  13. I forgot everything I read.
  14. I learned how to use Microsoft Access database to enter reference information about VIs, palettes, and dialog boxes.
  15. I learned how to generate HTML from XML.
  16. I learned how to use Perforce as source control.
  17. I learned how to use FAR HTML.
  18. I learned how to create and compile CHM help.
  19. I learned how to use the Corrective Action Request (CAR) database system.
  20. I fixed, filed, and validated over 300 CARs.
  21. I installed, uninstalled, and reinstalled LabVIEW over 20 times.
  22. I learned how to submit work requests to doc pro.
  23. I learned the basics of digital signal processing (DSP).
  24. I learned about digital filtering.
  25. I wrote a tutorial for LabVIEW Digital Filter Design Toolkit.
  26. I learned about the software development process.
  27. I learned about a product’s life cycle.
  28. I worked on a 1.0 project.
  29. I wrote an entire documentation plan.
  30. I wrote the entire documentation set for a 1.0 product.
  31. I submitted three work requests to doc pro.
  32. I wrote over 100 help topics.
  33. I created a PDF print-only help.
  34. I created 7 CHMs.
  35. I created 2 readmes.
  36. I submitted 8 deliverables to first review, final review, R&D signoff, and lead signoff. That’s 30+ reviews!
  37. I received and entered over 1000 edits.
  38. I started productivity forum to share tips and tricks.
  39. I cheered when NI ranked again in Fortune’s 100 Best Companies to Work For for the ninth consecutive years.
  40. I coordinated and organized a company-wide carnival party.
  41. I learned how to use Twiki.
  42. I learned how to use Atlassian Confluence Wiki.
  43. I coordinated the migration of our department’s internal website to Confluence Wiki.
  44. I joined the Content Wrangler Community.
  45. I migrated this blog from my personal domain to Shanghai Tech Writer.
  46. I changed the theme for this blog three times.
  47. I wrote over 200 articles for this blog.
  48. I participated in a snowball fight.
  49. I started a weekly Scrabble tournament.
  50. I’m #1 on the Scrabble scoreboard.
  51. I reviewed and published an article on NI Developer Zone.
  52. I became the social dictator.
  53. I organized 2 quarterly parties.
  54. I put together a digital scavenger hunt.
  55. I shared about my typical day as a technical writer at NI.
  56. I attended 3 quarterly parties.
  57. I attended end-of-the-year company party.
  58. I was part of the infamous R&D skit at the annual party.
  59. I attended NI China Ten Years anniversary at the Grand Hyatt.
  60. I attended 4 quarterly update meetings.
  61. I went to several department and team-building dinners.
  62. I attended 15 group lunches.
  63. I participated in 30 games of mafia.
  64. I got killed 26 times.
  65. I visited the snack table 100 times.
  66. I baked 20 dozens of chocolate chip cookies for the department.
  67. I received over 2000 emails.
  68. I sent over 1000 emails.
  69. I attended over 40 documentation team meetings.
  70. I met with my manager one-on-one more than 40 times.
  71. I worked closely with 8 subject matter experts (SMEs).
  72. I attended 10 New Employee Orientation (NEO) training.
  73. I gave one NEO training on “Best Email Practice.”
  74. I gave a few English training to engineers.
  75. I helped acquire new software (SnagIt) for the department.
  76. I created and implemented a spec.
  77. I reviewed over 20 specs.
  78. I filled out the timecards 52 times.
  79. I worked over 2000 hours.
  80. I cleaned out my cubicle twice.
  81. I updated the biweekly status reports 25 times.
  82. I updated my project schedule over 20 times.
  83. I received over 3000 RMB ($450) in meal subsidies.
  84. I received 3 NI shirts, 1 NI hat, and 1 NI flag.
  85. I biked to work over 200 times, a total of over 1000 kilometers (625 miles)!
  86. I saved over 2200 RMB ($300 USD) in taxis/gas.
  87. I printed out too many pages of specs, documentation, reviews, and garbage.
  88. I helped save papers/trees by printing double-sided two pages per side. That’s FOUR pages per piece of paper!
  89. I participated in NI Green Day. I wore all green.
  90. I attended a book club at work.
  91. I collaborated with a few technical writers in Austin.
  92. I wrote two articles for our internal newsletter.
  93. I got featured in ISTC Blog News.
  94. I got invited to attend LavaCon Advanced Technical Communication conference in Hawaii.
  95. I used up 2 notebooks.
  96. I switched from IE, to Firefox, to Maxthon, to Maxthon 2, to Firefox 3, to Chrome.
  97. I submitted 2 proposals for NI-TC, our annual internal tech comm conference.
  98. I visited NIC, the company headquarters in Austin.
  99. I met with Austin technical writers face-to-face.
  100. I presented a topic on “Learning Styles and Technical Writing” at NI-TC.

What a list! There are many more to add to the list but I’m stopping here. It has been a great year. I love my job as a technical writer, and I love working at NI.

Share and Enjoy:
  • Digg
  • del.icio.us
  • Facebook
  • email
  • Live
  • Reddit
  • StumbleUpon
  • Technorati
  • Google Bookmarks
  • Mixx
  • Slashdot
  • TwitThis

Related Articles:

Comments:

Total 5 Comments posted Year in Review: My First Year as a Technical Writer

Post a comment

CommentLuv Enabled
Cheap Web Hosting!