Upgrade to Pro — share decks privately, control downloads, hide ads and more …

What Technical Writers Do at LINE+

What Technical Writers Do at LINE+

LINE Plusのテクニカルライターとしての仕事
이인실(Lee Insil、イ・インシル) / LINE PlusのTech組織Technical Writingチーム Lead

韓国のテクニカルライティング業界、とりわけITソフトウェア分野について説明し、テクニカルライターとしての成長に役立つカンファレンスや教育機関を紹介します。主にLINEの韓国法人であるLINE Plusのテクニカルライターとしての仕事について紹介したいと思います。

※ 以下のイベントで発表した内容です
https://line.connpass.com/event/282376/

LINE Developers
PRO

May 11, 2023
Tweet

More Decks by LINE Developers

Other Decks in Technology

Transcript

  1. What Technical Writers Do at LINE+
    © LINE Plus
    Technical Writer
    Lee Insil
    [email protected]

    View Slide

  2. Technical Writer, connect people through documents
    Technical Writer
    Lee Insil
    ( 이인실 Ωϸμϰ )
    Major in Computer Engineering and Cryptography
    Programmer at AhnLab
    Technical Writer at AhnLab, LG Electronics, NAVER and LINE+
    Technical Writing Trainer at NAVER and LINE+

    View Slide

  3. What is Technical
    Writing
    01
    Contents
    02
    Making a career
    as a Technical
    Writer
    03
    What Technical
    Writers do at LINE+
    04
    Introduction to
    Technical Writing
    in Korea

    View Slide

  4. 01 02 03 04
    What is
    Technical
    Writing
    Making a career
    as a Technical
    Writer
    What Technical
    Writers do at LINE+
    Introduction to
    Technical
    Writing in
    Korea

    View Slide

  5. “Technical writing is performed by a technical writer (or technical author) and
    is the process of writing and sharing technical information in a professional
    setting.
    A technical writer's primary task is to communicate technical information to
    another person or party in the clearest and most effective manner possible.”
    Source: https://en.wikipedia.org/wiki/Technical_writing
    What is Technical Writing
    01

    View Slide

  6. Technical Writer
    Information
    Architect
    Technical
    Communicator
    API Writer
    UX Writer
    Document
    Engineer
    What is a Technical Writer also known as
    01

    View Slide

  7. Developer
    Product
    Planner
    Trainer
    Customer
    Care
    Technical Writer
    Stakeholder
    01
    Designer
    Promoter
    QA
    Engineer
    Project
    Manager
    Evangelist

    View Slide

  8. 02
    01 03 04
    What is
    Technical
    Writing
    Making a career
    as a Technical
    Writer
    What Technical
    Writers do at LINE+
    Introduction to
    Technical
    Writing in
    Korea

    View Slide

  9. Outcomes: End user manual, FAQ, Brochure, UI/UX messages, Services on
    the website, …
    Companies: LINE+, SAMSUNG Electronics, LG Electronics, TmaxSoft,
    AhnLab, HANCOM, HANMI Semiconductor, bitnine, Hansem global, EASY
    MANUAL, AST, TEXTree, Logrus IT, …
    Technical Writers
    Developers Users
    Documents for Users
    02

    View Slide

  10. Outcomes: Developers documents, API references, Tutorial guides,
    Engineer blog, …
    Companies: LINE+, NAVER, Kakao, Ground X, Coupang, LG Electronics,
    sendbird, Com2uS Platform, HYPERCONNECT, WhaTap, 우아한
    형제들(similar to Demaecan, 出前館), NEXON, …
    Documents for Developers
    02
    Technical Writers
    Developers Developers

    View Slide

  11. 03
    01 02 04
    What is
    Technical
    Writing
    Making a career
    as a Technical
    Writer
    What Technical
    Writers do at LINE+
    Introduction to
    Technical
    Writing in
    Korea

    View Slide

  12. Conferences
    03
    Source: https://www.stc.org

    View Slide

  13. Conferences
    03
    Source: https://www.writethedocs.org

    View Slide

  14. Conferences
    03
    Source: https://apithedocs.org

    View Slide

  15. Google Technical Writing Course
    Technical Writing course
    03
    Source: https://developers.google.com/tech-writing

    View Slide

  16. Simplified Technical English
    Technical Writing course
    03
    Source: https://www.shufrans-techdocs.com/services/simplified-technical-english/

    View Slide

  17. Communities in Korea
    03
    Source: https://cafe.naver.com/tcnkorea

    View Slide

  18. Communities in Korea
    03
    Source: https://cafe.naver.com/technicalwriting

    View Slide

  19. Communities in Korea
    03
    Source: https://url1.io/s/NBJW3

    View Slide

  20. 04
    01 02 03
    What is
    Technical
    Writing
    Making a career
    as a Technical
    Writer
    What Technical
    Writers do at LINE+
    Introduction to
    Technical
    Writing in
    Korea

    View Slide

  21. Linguist
    Technical documentation
    Site structuring
    Documentation in multi-
    languages
    Writing training
    Work experience of Technical Writers at LINE+
    04
    Developer
    Technical documentation
    Website structuring
    Document engineering
    Writing training
    Work experience Work experience

    View Slide

  22. Work experience of Technical Writers at LINE+
    04
    Linguist
    Technical documentation
    Site structuring
    Documentation in multi-
    languages
    Writing training
    Developer
    Technical documentation
    Website structuring
    Document engineering
    Writing training
    Work experience Work experience

    View Slide

  23. Technical Writers at LINE+
    Technical documentation
    Site structuring
    Documentation in multi languages
    Document engineering
    Writing training
    Work experience of Technical Writers at LINE+
    04

    View Slide

  24. Process of Technical Writing at LINE+
    04
    Developer/
    Planner
    Technical
    Writer
    EN/JA
    Translator
    Request
    document
    ation
    Documentation
    support?
    Kick-off
    meeting
    Documentation
    Requesting a
    translation
    Translate
    Review
    translation
    results
    Reviewing
    the
    contents
    Reflect
    translation
    results
    Release
    documents
    Yes
    Explaining
    the
    structure
    Drafting,
    answering
    questions

    View Slide

  25. • Released documentation of
    developer guides in multiple
    languages
    • Created a common wiki
    template
    • Offered wiki usage tips training
    (Japan, Korea, Taiwan)
    • Held LINE Developers Day 2015
    in Korea
    • Released documentation of the
    LINE GAME Platform in
    multiple languages
    • Documentation of Open
    Sources
    • Offered wiki usage tips
    training (Thailand, Indonesia)
    • Rewriting and release of LINE
    Engineering Blog in multiple
    languages
    • Built a Technical Writing team
    • Released documentation of the
    CLOVA AI platform in multiple
    languages
    • Offered writing training in
    Korean
    • Training on how to write git,
    annotation comments and issue
    tracking system in English
    • Released documentation of the
    LINE Blockchain and LINE MINI
    app in multiple languages
    • Consulting on structuring wiki
    • Held Technical Writing Day in
    Japan and Korea
    • Released documentation of the
    virtual currency platform and
    multimedia platform and
    infrastructure platform
    • Building a wiki sample space
    • Held Technical Writing Day in
    Taiwan, Thailand
    • Consulting on structuring wiki
    • Coaching on one-on-one
    technical writing
    • Released documentation of the
    multiple platforms in multiple
    languages
    • Released documentation of the
    LINE Pay, LINE Bank platform in
    multiple languages
    • Released documentation of the
    governance and process
    guidelines in multiple languages
    • Developing a website and writing
    terms in LINE Words (Korean)
    • Released documentation of the
    voice, video call platform and
    LandPress CMS platform in
    multiple languages
    • Developing a website and
    writing terms in LINE Words
    (Japanese, Korean, English)
    • Provided communication
    training to new employees
    Technical Writing experience at LINE+
    04
    2015 2016 2017 2018
    2019 2020 2021 2022

    View Slide

  26. Developer
    Contents team
    (Japan)
    Request
    documentation Share information,
    collaboration
    Technical
    Writing team
    (Korea)
    Release
    documentation
    for platform
    products
    Posting
    engineering
    blog &
    managing
    LINE Words
    Coach writing &
    consult
    documentation
    Planner
    Project
    Manager
    Evangelist
    Developer
    “Help with global
    platform business and
    communication”
    How we work at LINE+
    04

    View Slide

  27. • CLOVA Developers Console: https://developers.naver.com/console/clova/client
    • Game platform: Provide to a third party
    • LINE Blockchain platform: https://bitfront-exchange.github.io/bitfront-api-docs/#
    • Engineering blog (Korean/English): https://engineering.linecorp.com/en/blog
    • LINEDOCS development guide wiki: A collection of in-house development guides
    • LINE governance & process guidelines: Internal only
    • LINE Words: LINE dictionary
    Links to results
    04
    • Voice, video call platform: Provide to a third party
    • LandPress platform: Internal only

    View Slide

  28. View Slide

  29. QUESTIONS?
    +

    View Slide

  30. Technical Writer
    글로 사람과 사람을 연결
    LINE+ Corporation. All rights reserved.
    +
    THANK YOU

    View Slide