avatar
文章
39
标签
0
分类
9

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

技术文档工程师修炼

专利
发表于2024-06-06|专利与认证介绍
专利的类型专利的类型包括发明专利、实用新型专利、外观设计专利。 发明,是指对产品、方法或者其改进所提出的新的技术方案。其中,产品发明是人们通过研究开发出来的关于各种新产品、新材料、新物质的技术方案;方法发明是人们为制造产品或解决某个技术课题而研究开发出来的操作方法、制造方法以及工艺流程等技术方案。 实用新型,是指对产品的形状、构造或者其结合所提出的适用于实用的新的技术方案。 外观设计,是指对产品的形状、图案或者其结合以及色彩与形状、图案的结合所作出的富有美感并适用于工业应用的新设计。 对于发明和实用新型而言,最基本的条件是必须具备新颖性和创造性,简而言之,新颖性是指发明创造与现有技术具有不同点,创造性是指上述不同点对于本领域的技术人员来讲是不容易想到的;对于外观设计而言,最基本的条件是与已有的外观设计不相同或相近似。
产品认证
发表于2024-06-06|专利与认证介绍
产品认证介绍为什么需要产品认证?产品认证是指通过独立机构对产品质量、安全性、环保性等方面进行评估和验证,确保产品符合特定的标准和法规要求。产品认证不仅有利于提升消费者对产品的信任度,还能够帮助企业进入新市场、降低产品风险、遵守法律法规等。 主要原因包括: 保证产品质量和安全性:认证标志是产品质量和安全性的保证,消费者可以放心购买和使用。 满足法律法规要求:许多国家和地区对特定类型的产品有强制性认证要求,没有认证可能无法进入市场或面临法律风险。 提升市场竞争力:有认证的产品能够在市场上与竞争对手区分开来,提升品牌形象和市场份额。 降低产品召回和责任风险:认证有助于发现和解决产品设计或生产过程中的问题,减少产品召回和法律责任风险。 常见的产品认证以下是一些常见的产品认证类型: ISO认证系列:如ISO 9001(质量管理体系)、ISO 14001(环境管理体系)等,适用于各类组织和产品,确保符合国际标准要求。 CE认证:适用于进入欧盟市场的产品安全认证,确保产品符合欧盟的基本健康与安全要求。 FCC认证:美国联邦通信委员会的认证,用于电子产品的电磁兼容性和射频发射特性。 ...
基于Antora的文档框架说明
置顶|发表于2024-03-20|关于产品文档
文档架构说明 Antora是一个开源的文档生成工具,专注于构建技术文档。它使用 AsciiDoc 作为其主要的标记语言,并结合 Git 作为版本控制系统,提供了强大的文档管理和协作功能。 具体来说,这套系统的组成部分如下: Antora: Antora 是一个基于 Node.js 的静态站点生成器,专门用于构建技术文档。它允许你从多个源(如 Git 仓库)收集文档内容,并根据配置生成一个完整的静态网站。 Antora 支持模块化的文档结构,可以将文档分解为多个独立的模块(或组件),每个模块都有自己的版本控制和发布流程。 Antora 使用 AsciiDoc 作为默认的标记语言,AsciiDoc 是一种功能强大的文档标记语言,支持结构化内容、内部链接、图表和代码示例等丰富的功能。 AsciiDoctor: AsciiDoctor 是一个开源的文档处理器,用于将 AsciiDoc 标记转换为各种输出格式,包括 HTML、PDF 和 ePub 等。它是 Antora 使用的默认渲染引擎,负责将 AsciiDoc 标记转换为静态网页。 Git: Git 是一个分布式版本控制系统 ...
Git常用指令
置顶|发表于2024-03-10|关于产品文档
git init :在当前目录下初始化一个新的 Git 仓库。 git clone <repository-url> :克隆远程仓库到本地计算机。 git add <file(s)> :将文件添加到暂存区,准备提交到版本库。 git commit -m “commit message” :提交暂存区的文件到版本库,并附上提交说明。 git status :显示工作目录和暂存区的状态,查看哪些文件被修改或是已经准备好被提交。 git diff :显示工作目录中当前文件与暂存区文件的差异。 git log :显示提交日志,列出当前分支的所有提交记录。 git pull :从远程仓库拉取最新内容并合并到本地分支。 git push :将本地分支的更新推送到远程仓库。 git branch :列出本地分支,显示当前分支以及其他分支的信息。 git branch <branch-name> :创建一个新的分支。 git branch -d <branch-name> :删除指定的本地分支。 git branch -D <branch-nam ...
技术文档写作中常用的工具
置顶|发表于2024-03-10|关于产品文档
以下工具均为Web端工具,使用Web端工具可以跨平台且无需本地安装。 多媒体 Figma:https://www.figma.com/ Figma是一款用于产品设计的平台,但其也可用于设计、制作、存储、管理技术文档中的插图,并且可以实现多人协作。 MasterGo:https://mastergo.com/ 国产类Figma平台 查图:https://www.pinterest.com/ 翻译 Google翻译: https://translate.google.com/ DeepL:https://www.deepl.com/zh/ 英文语法检查:https://app.grammarly.com/ 其他 ChatGPT: https://chat.openai.com/ PDF处理: https://www.ilovepdf.com/zh-cn PDF转PNG: https://pdf2png.com/zh/ 图片文字处理:https://web.baimiaoapp.com/
基于Aantora文档的GUI工具
发表于2024-01-08|Python学习与实践GUI
最终实现效果 前端GUI 界面使用 Python 中的 tkinter 库实现。 后端
Hexo + Github 搭建博客教程
发表于2023-12-04|视频与动画
Hexo + Github 搭建博客教程(上) Hexo + Github 搭建博客教程(中)
做视频的思路
发表于2023-12-04|视频与动画
思路 先确定视频的【目的】,明确【视频类型】,例如市场宣传、功能简介、操作详解等。 头脑风暴罗列一下视频里面要传递的信息,做一个【信息列表】。这个阶段可以先发散再删减,列的时候先不用考虑章节结构。这个信息列表再根据【重要性】和【依赖关系】,经过删减,把要传递的信息整理成一个树状关系。如果发现信息太多,很可能进一步删减或者需要拆成多个视频。 画视频的【思维导图】:视频的章节结构,每个部分要讲哪些信息。对照信息列表,看看是不是覆盖了。 从思维导图,出【解说词】,然后是【分镜头】,解说词和分镜头很可能需要来回修改,但是解说词优先级更高。 对着解说词和分镜头草稿,人工讲一下,类似讲ppt,这个过程很可能发现有地方不对劲,就需要向前回溯修改。 最后再剪辑视频。 示例下图是一个本地部署hexo的思维导图,用于总结视频的结构、词稿、分镜等。
从文件中读取一个变量
发表于2023-11-27|Python学习与实践脚本
需求将变量写在一个文件中,脚本每次读取文件中的变量进行处理。 代码12345678910111213141516171819# 读取文件file_path = 'input.txt'try: with open(file_path, 'r') as file: # 从文件中读取变量 variable_to_process = file.read() print(f"从文件中读取的变量值为: {variable_to_process}") # 在这里可以对变量进行处理 # ...except FileNotFoundError: print(f"找不到文件: {file_path}")except Exception as e: print(f"发生了错误: {e}")
12…5
avatar
李肇阳 | Zhaoyang Li
文章
39
标签
0
分类
9
分类
  • Python学习与实践15
    • GUI2
    • 学习总结8
    • 脚本5
  • 专利与认证介绍2
  • 中文技术文档的写作理论参考6
  • 中文技术文档的写作规范参考7
  • 关于产品文档7
©2023 - 2024 By 李肇阳 | Zhaoyang Li
框架 Hexo|主题 Butterfly