格式要求https://github.com/ruanyf/document-style-guide内容参考目录结构参考编写目的 需求背景 定义 - 列出文档中用到的专门术语定义和缩写词的原意 竞品分析（可选） 方案设计/系统设计 方案优缺点对比分析（可选） 细节/特殊点补充（可选） 结论（可选）...
原创
2021-05-20 20:37:05
447阅读
格式要求https://github.com/ruanyf/document-style-guide内容参考目录结构参考编写目的需求背景定义 - 列出文档中用到的专门术语定义和缩写词的原意竞品分析（可选）方案设计/系统设计方案优缺点对比分析（可选）细节/特殊点补充（可选）结论（可选）
原创
2022-03-29 15:47:57
475阅读
软件架构设计通常会考虑业务功能（客户需求）和非功能性需求（易用性、可靠性、移植性、性能、扩展等），容易忽略开发人员的自我感受。架构/框架解决不了所有问题，开发人员的主观能动性极为重要。实际上软件框架的用户是开发人员而不是最终用户，保证开发人员稳定性、积极性、好招聘是一个框架的非功能性需求。框架最终形态最好为：1、提供了基础框架（方便使用，规格一致）。定下系统基本基调，实现基本功能，考虑扩展和性能等
**软考文档书写规范**
在软件行业，文档书写是每个从业人员都必须掌握的基本技能之一。特别是在软考（软件水平考试）中，文档书写规范更是考生必须熟知和遵循的重要标准。本文将详细阐述软考文档书写的基本规范，帮助考生和从业人员提高文档书写质量。
**一、文档结构清晰**
软考文档首先要做到结构清晰。一个完整的文档通常包括封面、目录、正文、附录等部分。封面应包含文档名称、编写者、审核者、版本号等基本
原创
2024-03-13 18:25:39
117阅读
在软件行业，软考（软件专业技术资格和水平考试）是衡量专业人员技能水平的重要标准。而在软考中，文档书写规范标准则占据了举足轻重的地位。一篇规范、标准的文档不仅能提高软件开发的效率，还能在团队协作中起到事半功倍的效果。本文将围绕软考文档书写规范标准展开探讨，帮助读者更好地理解和应用这些标准。
首先，我们要明确文档书写规范标准的重要性。在软件开发过程中，文档是团队成员之间沟通的主要桥梁。一个书写规范的
原创
2024-05-16 21:13:48
79阅读
apidoc是一款利用源代码中注释来创建RESTful Web API文档的工具。apidoc可用于C＃，Go，Dart，Java，JavaScript，PHP，TypeScript和所有其他支持Javadoc的语言。安装npm install apidoc -g运行apidoc -i myapp/ -o apidoc/ -t mytemplate/myapp/ 根据myapp
转载
2018-11-18 22:40:00
140阅读
2评论
API文档对于API的可用性和成功至关重要。完善的API文档能显著提高开发者体验，加速采用，并培养强大的开发者社区。反之，糟糕的文档可能导致困惑、挫败感和错误，从而降低采用率。本文将探讨编写清晰、全面、开发者友好的API文档的高级最佳实践，并附带示例以帮助理解。1.定义API的目的在开始编写文档之前，必须清楚了解API的目的。它解决了哪些问题？目标受众是谁？主要用例是什么？目标受众： 定
软考文档书写规范要求
在软件行业，文档编写是一项至关重要的任务，它不仅关系到软件开发过程的顺利进行，还直接影响到软件产品的质量和后期的维护工作。特别是在软考（软件水平考试）中，文档书写更是考察考生综合素质和专业技能的重要环节。因此，掌握文档书写的规范要求，对于软考考生来说具有重大的实际意义。
一、文档书写的基本原则
1. **清晰性**：文档应使用简洁明了的语言，避免使用含糊不清或有歧义的词
原创
2024-05-08 17:35:00
68阅读
通过这段时间对面向对象思想的学习，并运用面向对象的思想进行思考（向面向对象靠拢） ，终于将此软件的类图画出来了。
很有可能是不对的，但这也是非常有意义的进步。起码这样的画法说服了自己。
&n
原创
2010-11-06 15:58:24
562阅读
点赞
1评论
机房收费系统用例图
我们怎样才能够从需求分析中得出用例图呢?
我按照软件的用户进行分析，通过用户在实际工作中的需求进行分析得出我们需要的用例图。
首先我们分析一下用户，此系统中有四个用户：学生（固定用户和临时用户）、值班教师、会计和机房管理员。
然后我们对他们进
原创
2010-10-27 11:10:24
500阅读
一、Hololens概述 Hololens有以下特性 1、空间映射借助微软特殊定制的全息处理单元（HPU），HoloLens 实现了对周边环境的快速扫描和空间匹配。这保证了 HoloLens能够准确地在真实世界表面放置或展现全息图形内容，确保了核心的AR体验。 2、场景匹配HoloLens 设备能存储并识别环境信息，恢复和保持不同场景中的全息图像对象。当你离开当前房间再回来时，会发现原有放置的全息
1、确认需求：用自己的话再给对方复述一遍2、分析需求：表面需求内在需求扩展需求是否合理3、分析资源：人+资源+时间+依赖资源4、边界：功能性需求（数据收集、加工、存储、展示）非功能性需求（易用性、可用性、性能、完整性、强一致性等）5、技术选型-技术广度：已有轮子自己写轮子6、概要设计：架构图等7、详细设计：领域模型、UML图、数据库表结构等8、接口基本设计：接口的命名、请求参数、支持的协议。TPS
转载
2024-03-25 15:37:54
51阅读
TRUNK的技术背景、实现步骤、以及配置。gvrp端口解释及使用。 交换机端口类型： 链路聚集模式：1.TRUNK的技术背景：划分多个vlan之后，解决不同交换机之间相同vlan的通信问题、相同vlan在不同交换机上跨越地理位置的通信问题 1.实现步骤： 设置一条主干链路————trunk 干道协议：802.1Q 2.trunk链路配置 静态配置： interface G0/0/24 port l
转载
2024-05-30 07:52:00
102阅读
<div class="postBody"> <div id="cnblogs_post_body" class="blogpost-body cnblogs-markdown"> <div id="html-0"><!-- run --> <style> #mainContent, body {
原创
2021-07-23 10:15:45
178阅读
1、什么是PRD文档产品需求文档是产品项目由“概念化”阶段进入到“图纸画”阶段的最重要的文档，其作用就是对MRD（市场需求文档）中的内容进行指标化和技术化，这个文档的质量直接影响到研发设计部门是否能够明确产品的功能和性能。2、文档属性3、历史修订4、产品描述产品介绍、产品定位、目标人群...
原创
2021-07-12 16:31:15
776阅读
在Java编程中撰写方法文档注释是一个优良的习惯，它不仅能提升代码的可读性，还能帮助其他开发者快速理解代码的功能和用法。本文将为你详细讲解如何在Java方法中自带文档注释，包括问题背景、错误现象、根因分析、解决方案、验证测试和预防优化的全过程。
随着项目的不断扩大，维护代码的复杂度逐渐增加。然而，我发现我的Java方法中缺少合适的文档注释，导致团队中的其他成员在使用这些方法时读不懂其用法。这种现
本文主要介绍了前端布局方案的实现以及存在的问题，涉及到的布局方案包括：流体布局float布局table布局定位布局flex布局响应式布局grid布局前端布局从最开始的：Table布局 => DIV+CSS布局 => Flex布局 => Grid布局 经历了以上一系列变化，这些变化伴随着前端技术的发展和程序猿对布局方案便利性的追求，最终的结果就是让我们的网页设计变得越来越方便、快捷
中兴通讯在持续的全球高端客户文档交付中积累了丰富的科技文档写作经验，他们把他们的经验输出成这本《科技文档写作实务》。本文是我的读书笔记。- 1 -概述篇1.1 什么是技术文档科学技术文档（简称科技文档）以客观严谨的语言记录科技事实、沉淀科技经验、发表科技成果和传递科技信息，是科学技术知识体系的重要组成部分。在产品研发和制造领域，技术文档分为两类：一类指产品开发中要用到的研发文档；另一类是
转载
2023-10-27 06:58:58
203阅读
随着 Apple 发表新款 iPad Air 和 iPad mini，往后旗下所有 iPad 都将支持 Apple Pencil，因此苹果也推出 iWork 2019 的更新，包括 Pages、Numbers 和 keynotes…等，都有对应的新功能，且针对 iOS 版本新增不少功能，当中，Pages 上支持中文、日文和韩文的垂直书写，更提供日文与繁体中文的文字模板。iWork 2019 更新，
转载
2023-07-27 17:40:36
290阅读
基础设施环境# 总体採用 centos6.5 + nginx + tomcat7.0
负载均衡:nginx 配置，使用 nginx 作为负载均衡。权重配置。 在web层做到水平扩展、
以及配置日志格式，支持db、cache调用次数。响应时间，做全站的监控、
支持相应參数的配置，方便日后做大数据营销的规划，相应的hive表，做分析使用
web层:採用一主一备。
转载
2023-11-29 15:18:36
58阅读
