index.rst

技术写作：原理与实践(2020)

本书用于《技术文档写作》课程的教学，因为服务于技术写作课程的教学，本书将采用当前流行的 Doc like Code 的模式进行写作。

所用的工具如下：

1. 内容写作。采用轻量级的标记语言：reStructuredText
2. 文档发布工具。Sphinx
3. 协同与版本控制。github
4. 文档托管。Read the Docs
5. 写作工具。MS Visual Studio Code

本课程选课同学将按照技术写作的流程，参与到教程的写作和审校工作中。

Note

目前图书只是列出了大纲，内容正在写作中。请持续关注。

.. toctree::
   :maxdepth: 1
   :caption: 第一章：概述

   1-introduction/techwriting
   1-introduction/techcomm
   1-introduction/techcomm-industry
   1-introduction/techcomm-competence
   1-introduction/

.. toctree::
    :maxdepth:1
    :caption: 第二章：常见用户帮助形式

    2-user_support/manual.rst
    2-user_support/csh.rst
    2-user_support/chm.rst
    2-user_support/wiki.rst
    2-user_support/walkme.rst
    2-user_support/help-desk.rst
    2-user_support/api-doc.rst

.. toctree::
    :maxdepth:1
    :caption: 第三章：用户需求分析

    3-user-analysis/behavior.rst
    3-user-analysis/human factors
    3-user-analysis/task model.rst
    3-user-analysis/info-need-model.rst

.. toctree::
    :maxdepth:2
    :titlesonly:
    :caption: 第四章：技术信息设计

    4-information-design/minimalism.rst
    4-information-design/single-sourcing.rst
    4-information-design/progressive.rst
    4-information-design/emotional.rst
    4-information-design/storytelling.rst
    4-information-design/gamification.rst

.. toctree::
    :maxdepth:1
    :titlesonly:
    :caption: 第五章：技术信息开发技术基础

    5-info-develop/html
    5-info-develop/xml
    5-info-develop/dita_intro.rst
    5-info-develop/dita.rst
    5-info-develop/lightweight
    5-info-develop/versioning.rst

.. toctree::
    :maxdepth:1
    :caption: 第六章：常用技术写作工具

    6-tools/oxygen
    6-tools/madcap
    6-tools/robohelp
    6-tools/fm.rst

.. toctree::
    :maxdepth:1
    :caption: 第七章：技术信息产品评价

    7-evaluation/usability.rst
    7-evaluation/heuristic.rst
    7-evaluation/content-analysis.rst
    7-evaluation/automatic.rst

.. toctree::
    :maxdepth:1
    :caption: 第八章：综合实训案例

    8-projects/antconc.rst
    8-projects/omegat.rst

.. toctree::
    :maxdepth:2
    :titlesonly:
    :caption: 第九章：新型用户帮助技术

    9-other_user_support/ar.rst
    9-other_user_support/chatbot_intro.rst
    9-other_user_support/chatbot.rst
    9-other_user_support/e-learning.rst
    9-other_user_support/interactive-book.rst

.. toctree::
    :maxdepth:1
    :caption: 期末论文

    10_term-paper/term-paper.rst

目录与表格

• :ref:`genindex`
• :ref:`modindex`
• :ref:`search`