服务器 Gind.cn

服务器问题集锦,包括 Linux(Ubuntu, Centos,Debian等)和Windows Server服务器

IT技术作家是否有标准/惯例?

TL:DR? 精…这里: 技术编写者在其业务中使用的基本标准/惯例/惯例是否可以从中学习,以创build适当的IT文档并随时间维护文档? 在为员工内部IT使用和外部使用编写各种文档的同时,我们的员工在文档编制方面都有自己独特的风格。 从我们的质量文件和受控文件中抽取出来,IT已经利用SOP,WI和用于IT质量文件的各种forms的各种模板。 这些文档虽然不一定对于IT部门的日常运作有用,但可以帮助员工和公司解决IT人力资源问题,合规性等问题,而且通常写得很好,定义明确,并至less遵循质量部门的模板和文档标准(如版本控制,ECN等) 但是我们实际的IT文档写作仍然缺乏真正的规范/标准。 有些会使用第三方工具,如ScreenSteps,其他人只需使用Word,并创build一个简单的轮廓,如: 打开app 点击“启动全球热核战争” … 利润 内部IT文档实际上更糟糕 ,根据员工或顾问在当时是否足够轻松自己的记忆或基于他们select的编辑(vi,word,excel,powerpoint,napkin,内部维基)而言。 问题出现在员工离开或休假时,甚至连基本信息都被搞混了。 有时只有文件date是数据是否仍然相关的指标。 虽然一个简单的轮廓,实际的截图,甚至全高清video都很好,我们没有一个真正的IT技术作家的工作人员,不禁觉得我们缺乏这方面。 我们是否可以用我们自己的标准来编写我们的文档以及经批准的模板? 是的,但为什么重新发明轮子? 如果这样的标准和惯例已经存在于技术作家的“行会”中,我们最好遵循这些惯例,以便我们的文件清晰,简明和专业。 为了避免被告知“ Google It ” ,我确实查看了显示一些格式化操作的站点,虽然SF Q: IT Documentation Platforms帮助寻找处理写作的平台和软件,但并没有讨论是否真的有标准行业。 因此,在招聘或外包给技术作家之前,技术作家是否有一些基本的标准/惯例/惯例可以从中学到,以创build适当的IT文档并随时间维护文档。