avatar
文章
39
标签
0
分类
9

首页
时间轴
分类
友链
关于
技术文档工程师修炼
首页
时间轴
分类
友链
关于

技术文档工程师修炼

os
发表于2023-10-31|Python学习与实践学习总结
简介os 全称为 operating system,这个模块提供了与操作系统交互的各种函数,我们可以通过这些函数调用计算机底层操作系统的部分功能来快速、高效地管理文件和目录。 此篇文章列举了os模块常见函数及其说明。 函数及其说明 os.getcwd() 得到当前工作目录,即当前Python脚本工作的目录路径。 os.listdir() 返回指定目录下的所有文件和目录名。 os.remove() 删除一个文件。 os.removedirs() 删除多个目录。 os.path.isfile() 检验给出的路径是否是一个文件。 os.path.isdir() 检验给出的路径是否是一个目录。 os.path.isabs() 判断是否是绝对路径。 os.path.exists() 检验给出的路径是否存在。 os.path.splitext() 分离扩展名。 os.path.dirname() 获取路径名。 os.path.basename() 获取文件名。 os.system() 运行shell命令。 os.rename( ...
shutil
发表于2023-10-31|Python学习与实践学习总结
简介shutil库,它作为os模块的补充,提供了复制、移动、删除、等操作。 函数及其说明 shutil.copy(src,dst) 复制文件。 src表示源文件,dst表示目标文件夹。 shutil.copytree(src,dst) 复制文件夹。 只能移动到一个空文件夹,而不能是包含其他文件的非空文件夹。 shutil.move(src,dst) 移动文件/文件夹 shutil.rmtree(src,dst) 删除文件夹 区别os模块中的 remove() 方法只能删除某个文件,mdir() 只能删除某个空文件夹,shutil 模块中的 rmtree() 可以递归彻底删除非空文件夹。
tkinter
发表于2023-10-31|Python学习与实践学习总结
简介tkinter 是 Python 中的标准 GUI(图形用户界面)库,它提供了创建窗口、按钮、文本框等常见 GUI 元素的功能。tkinter 基于 Tk GUI 工具包,并且是 Python 标准库的一部分,因此无需额外安装。 以下是 tkinter 的一些基本概念和用法: 导入 tkinter 模块: 1import tkinter as tk 创建主窗口: 1root = tk.Tk() Tk() 创建了一个主窗口对象。 添加组件: tkinter 提供了各种组件(widgets),如按钮、标签、文本框等。你可以使用这些组件构建你的 GUI。 12label = tk.Label(root, text="Hello, tkinter!")button = tk.Button(root, text="Click me!", command=callback_function) 在上面的例子中,Label 是一个标签,用于显示文本;Button 是一个按钮,通过 command 参数关联一个回调函数,当按钮被点击时执行。 布局管 ...
Easy to use - Accuracy
发表于2023-10-31|中文技术文档的写作理论参考
准确只有在你理解了信息后,才写下来,并在写作完成后进行验证Write information only when you understand it,and then verify it. 当您发布信息时,您必须充分了解该主题,以便可以告诉用户他们需要了解什么。 有时你可以很快地理解这个主题,并且能够毫无困难地准确、清晰地写出它。 在其他时候,这个主题是新的并且没有很好的记录。 也许某个软件产品不可供您尝试,或者技术上专家无法在一开始就向您解释该主题。当你无法获得产品的第一手经验或无法获得技术专家的帮助时,你必须从你所了解的内容开始撰写初稿。 考虑在早期草稿中向专家提出问题,以征求您为用户微调信息所需的解释。 技术专家有时更擅长审查书面内容并找出不准确之处,而不是从头开始记录技术主题。 编写信息并根据需要多次对其进行审核,以确保在您发布信息时信息准确无误。 理解你所写的技术主题的最佳方法是像用户一样使用该产品。作为一名作者,你越多地使用产品、工具或界面,你就越能对信息的准确性负责。例如,当你编写基于两个表的数据库视图创建过程时,你可以使用界面来决定包含哪些步骤。然后,在完成过程编写后, ...
zipfile 压缩与解压缩
发表于2023-10-31|Python学习与实践学习总结
简介zip格式编码的压缩和解压缩。 压缩123456789import os,shutil# 获取需要打包的文件列表file_list = os.listdir(input())# 创建一个 ZIP 压缩文件with zipfile.ZipFile('example.zip', 'w') as zipf:# 添加文件到压缩文件 for file in file_list: zipf.write(file) 读取压缩包中的文件信息12345 import zipfilewith zipfile.ZipFile('example.zip', 'r') as zipf: file_list = zipf.namelist() 解压1234import zipfilewith zipfile.ZipFile('example.zip', 'r') as zipf: zipf.extractall('path& ...
Easy to use - Completeness
发表于2023-10-31|中文技术文档的写作理论参考
完整涵盖所有支持用户任务的主题,仅限于那些主题Cover all topics that support users’ tasks, and only those topics. 技术信息的用户需要了解如何使用产品来完成工作任务。这个指南与任务导向的质量特征相关,因为在明确用户并评估这些用户要执行的任务之前,你无法决定涵盖哪些主题。通过了解用户及其任务,你就知道哪些主题是相关的。最基本的任务主题包括主要任务的描述、它们的子任务、执行它们的原因或条件,以及如何应对预期的错误。在写作项目的早期阶段,进行任务分析以确定用户需要执行的任务和子任务。项目后期,你可以使用任务分析来评估你的信息是否涵盖了必要的主题: 你是否涵盖了所有主要的用户任务? 你是否描述了用户完成主要任务所需的所有子任务? 你是否解释了与可选任务相关的原因或条件? 你是否描述了如果出现问题应该怎么做? 如果这些问题的答案都是肯定的,你的信息更有可能涵盖用户所需的所有主题。 有时,您需要在介绍一个主题、解释一个过程或强调优势时解释概念。不要将概念与关于产品内部的信息混淆。概念有助于用户学习,因为它们提供了必要的词汇或大局的 ...
Easy to understand - Clarity
发表于2023-10-31|中文技术文档的写作理论参考
清晰大多数作者第一次尝试写作时,文字并不清晰。通常,为了突破障碍,作者会像说话一样写作,但这种方法会引入问题,如不必要的词语、模糊的指代和冗长的句子。在说话时,人们可以通过视觉和听觉线索来理解,但书面文字必须独自传达信息。 清晰的信息主要是重写的结果——替换、添加和删除部分以实现清晰度。清晰的信息需要密切关注词语、短语、句子、列表和表格等要素,以确保每个要素在信息中得到适当的参与。这种关注在重写时可能比初次写作时更有帮助。 清晰性为许多关于文体和视觉效果的决策提供了基本原理。例如,您可能选择对某些词语使用粗体,对某些其他用途使用斜体;始终应用这些文体决策可通过使信息更容易被用户第一次理解而增强清晰度。 传统上,技术写作中实现清晰度的指南主要基于经验和对以英语为母语的人,尤其是美国英语的使用者的研究。然而,由于在Web上技术信息的激增以及技术信息在全球范围内的增加使用,技术作者必须对国际受众对清晰英语的需求也保持敏感。 清晰度的一些方面还涉及完整性(尤其是相关性和信息过多)和组织(尤其是一致性和从属性)的一些方面。清晰的信息需要强调用户需要了解的内容以及何时需要了解。多余的信息会混淆信息 ...
Easy to understand - Concreteness
发表于2023-10-31|中文技术文档的写作理论参考
Easy to use -Task orientation
发表于2023-10-31|中文技术文档的写作理论参考
任务导向Task orientation. 为目标读者撰写Write for the intended audience. 在你开始写之前,确保你对读者有一个清晰地认知。 例如,如果你的读者是管理人员,你可能只包含高层次的任务,如评估和规划,或其他任务的高层次概述。同样,如果你是为最终用户写作,请避免系统管理员的任务。 确保你在主题中包含的信息你的读者会感兴趣。例如,你的产品可能拥有一个强大的新帮助系统,但是对于正在安装产品的人来说,帮助系统功能的描述可能并不那么引人关注。 由用户视角呈现信息Present information from the user’s point of view. 从用户的角度撰写将用户融入“故事”中,使他们能够轻松地想象执行你所描述的任务。这样的写作具有以下特点: 主要以“你”(第二人称)为对象。 使用主动语态,使用表示用户执行的动作的动词,而不是产品执行的动作。 为这些动作提供原因。 The system should not be shut down during processing. If such a shutdown occurs, th ...
12345
avatar
李肇阳 | Zhaoyang Li
文章
39
标签
0
分类
9
分类
  • Python学习与实践15
    • GUI2
    • 学习总结8
    • 脚本5
  • 专利与认证介绍2
  • 中文技术文档的写作理论参考6
  • 中文技术文档的写作规范参考7
  • 关于产品文档7
©2023 - 2024 By 李肇阳 | Zhaoyang Li
框架 Hexo|主题 Butterfly