程序员文档写作能力(二)-大三段式构架你的文档

本文介绍了程序员编写技术文档时采用的大三段式构架,包括虎头、猪肚、豹尾三个部分。虎头涉及业务需求背景、设计原则和潜在风险,旨在清晰传达需求理解与设计思路;猪肚涵盖了技术栈、架构设计、数据流等详细内容,展示方案的全面性和深度;豹尾则是总结和项目计划,确保设计方案的完整性和可行性。通过这种方式,可以提高文档的沟通效率和质量,形成团队知识库积累。
摘要由CSDN通过智能技术生成

内容概要

我们今天先从最最常用的平日工作中经常要用到的你的主管、老板让你留文档这种常用技术文档(含设计文档)入手来入门吧。

第一大段-虎头

哎,这个名字起的好。今年是虎年,祝愿各位虎虎生威。

为什么叫虎头?虎头威武吧?虎头是不是很美?它有金黄色的毛发、额头有着明显的“王”字,用国家地理杂志形容老虎,那真是“一头美丽的动物”。

从感观上来讲是不是夺人二目

老虎吼一声,那是自带次声波的,一般狗啊、猫啊、其它食草类动物包括人类听到老虎如果近距离吼直接四脚是“瘫软”的,是不是。。。“先声夺人”啊?

回到正题来。

业务需求你要对它进行设计、或者是出于某个创新目的你要做设计,上手先说一下这个需求的背景。

业务需求背景属于“虎头”。

你不要无脑只是copy一下业务的需求简介,笔者近10多年来包括接触的好多供应商讲标,一般这个需求背景写的好的往往者是深入研究过业务需求和了解本行业眼下潮流知道基本痛点的,那是一种

  • 5
    点赞
  • 12
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

TGITCIC

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值