沃土说明文档
文档站

需求

文档站现在要满足的范围,以及礼渠结算第一批还没写的问题。

站点

  • 一个站覆盖多个项目。每个项目是 content/docs/ 下的一个目录,meta.json 里把 root 设为 true,名称出现在文档页顶部。
  • 界面使用简体中文。
  • 从业务系统点进来的地址直接打开该项目,不经过项目列表。
  • 搜索带项目标签。停在礼渠结算时,只搜这个标签。
  • 这个进程提供页面、搜索,以及给助手读的 Markdown。不连接结算的 Java 后端,也不建数据库。

文章

  • 一页一件事。标题写成同事会问的那句话,正文写她下一步点哪里。
  • 同事打开的项目里,不放开发用的需求说明书、计算公式和页面说明。
  • 文章放在本仓库对应的项目目录里。业务规则改了,这一页跟着改。
  • 页面上如果以后加按钮或练习块,Markdown 里留下同样的一句说明,助手才能读到。

助手读取

  • /llms.txt 列出全部文章的标题和地址。
  • 每一页有一份 Markdown,地址是该页后面加上 .md。
  • 助手只读当前项目,不把几个项目合成一份全文。
  • 页数还少的时候,按项目取出那几页即可。

礼渠结算第一批要写的问题

写的时候放在「礼渠结算」下面。一页一个问题。

已经写了的:

  • 跟着做:从登录走到经营总览。结算公司、合作主体、商品、渠道关系、客户合作关系、项目立项,然后导入、对账任务、订单明细、本期账单。

跟着做里已经碰到「每周 / 每 N 天 / 按项目 / 按批次」「没有业务日」「待收货不进本期」「对账日前先看明细」「经营总览看的是上一个完整月」。下面这些仍是单独的问答页,还没写。

已经确定她会拿来问、还没写的:

  • 关系是每周、每 N 天、按项目、按批次
  • 没有业务日
  • 待发货、待收货,没有收货时间,也没有记下线下已取走
  • 对账日还没到,为什么不能确认

对照现有页面时还要能回答的:

  • 表里有日期,为什么说没有业务日
  • 点过重新检查,正式合同还是不能用
  • 没有成交单价,或金额是 0
  • 这一期已经确认或已发布,新表为什么没进去
  • 同一家公司、同一个客户有两条有效关系
  • 顶栏的结算公司或负责人不是这一批
  • 一条采购或费用同时符合多条关系
  • 供货还没确认,所以没有供应商草稿

以后再做

  • 助手对话。密钥和「只查当前项目」放在这个 Node 进程里。
  • 快速跳转分两种。文档页之间用站内地址。跳进业务系统,要有该项目的站点地址和页面对照,这份对照跟该项目的文章放在一起。
  • 新人练习是这一个项目里的一条路径。先不记录谁做完了哪一节。

不做

  • 不把说明做成盖住操作的引导层,也不拿掉业务系统里还不能点的按钮。
  • 不把 Vben、微信小程序那些公开框架文档收进来。
  • 不在页数还少的时候另做一套向量库。

本页目录