一.背景
为公司师带徒的任务做些记录。
二.文档存在的问题
1.文档情况
FORMAT-格式转换- FineBI帮助文档 FineBI帮助文档
函数定义：
|-----------------------|
| FORMAT(object,format) |
formart的格式有哪些呢？我们截图看看：
2.文档说明不足问题
同事的需求是把时间的时分秒取出来，例如时间是'2024-03-15 00:30:15'，
FORMAT(date1,'h:mm:ss a')得到的的是'12:30:15 上午'，并不是期望的'0:30:15'。
好在同事有开发思维，去掉了后面的' a'，FORMAT(date1,'h:mm:ss')得到的是'12:30:15'，上了'上午'，说明格式是可以手动组装的，这个规律一般人都可以摸索出来。这样应该添加一句说明，格式是可以用不同字母组装。特别是对于非计算机专业人士来说，很有必要。但明明是0点，不是12点啊！
同事找到我，我看了文档也懵。心想FineDataLink作为一个大数据工具，多半数据库的一些时间格式可能也支持。我想到了12小时制与24小时制 的区别，尝试着把format参数修改了一下，让同事执行FORMAT(date1,'H:mm:ss')得到的是'0:30:15'，这个就是同事要的结果了。果然有大H和小h的支持！我又让同事执行了FORMAT(date1,'HH:mm:ss')得到的是'00:30:15'，说明1个H和2个HH的补位区别。
我的建议是文档应该补充介绍大H和小h、单H和双HH的区别。
三.说明文档定位的问题
大数据时代，工具更多面向普通人，说明文档要尽量站在普通人的角度。