关于中文插件开发与使用文档编写及维护

[windingwind]

大家好，我设想编写维护一份中文的插件开发文档，同时考虑是否需要将我的几个插件的文档做一份中文版，也一并归到此团队？
另外，我目前在飞书平台上编写文档，看起来协作、编辑与评论比较方便。可能本仓库的一些文档也可以在这类协作工具上创建副本，用于分享？
希望听听大家的想法。

[northword]

我设想编写维护一份中文的插件开发文档，同时考虑是否需要将我的几个插件的文档做一份中文版，也一并归到此团队？

支持！

插件的中文文档，如果是面向用户的话，我觉得可以归入 Zotero 手册。我之前在 https://github.com/orgs/zotero-cn/teams/all/discussions/2/comments/7 这个讨论里提到想要维护一份单独的 Zotero 手册，就是想不仅包括 Zotero 本身的使用，也包括一些好用插件的使用。

如果是面向开发者，例如 api 等，可以放进开发文档。

另外，我目前在飞书平台上编写文档，看起来协作、编辑与评论比较方便。可能本仓库的一些文档也可以在这类协作工具上创建副本，用于分享？

还没有用过飞书，用过 GitBook ，感觉协作也不错，并且可以将源文件双向到 GitHub 仓库¹。
其实我最开始设想的只是用 Markdown 写，Mkdocs/VuePress 之类的工具构建网页，Actions 自动部署。不过对于有很多人同时写的话，确实不如实时协作工具方便。这个大家可以讨论一下用哪种方案。

UPDATE: 简单看了下 飞书/云文档/知识库 的帮助文档，感觉和语雀是差不多的，二者与 GitBook 的定位稍有不同，虽然三者都是都是知识管理，但 GitBook 可能更偏向对外的知识分享，例如书籍、文档等。
GitBook 的入门门槛可能要比前两者高一些，比如英文界面，需要了解 Git 和 PR 概念等，本土化可能也不如前二者。
另外， @l0o0 之前有提到注册域名，如果 GitBook 可以在国内访问的话，倒是可以把文档子域名绑定到 GitBook。如果我没看漏或看错的话，飞书和语雀（各自免费版）目前还不支持绑定域名。
算是各有优缺，可以作为一个选择。

再次 UPDATE：不好意思，看错了，GitBook 个人免费，创建组织是付费的 orz，不过开源项目似乎可以申请免费。

---

之前没有收到这条讨论的邮件通知，可能是需要 @zotero-cn/all 这样 call 一下大家。

Footnotes

1. https://docs.gitbook.com/integrations/git-sync ↩

[l0o0]

@northword 那我准备测试一下，看看访问速度如何

[northword]

iframe方式的转发基本上宣告没啥大用了，用户上不去github的还是上不去。只能像northword所说，给团队主页设置一个好记的域名。

那我准备测试一下，看看访问速度如何

要补充一下，转发到的地址必须是备案的，所以只能转发到 gitee ，不能转发到 github ，除非我们不在国内买域名/不用国内的 dns 服务商。

[windingwind]

转发到gitee也许还可以，折衷的办法也只有这个了

[northword]

大家好，

几天前在 Gitbook 申请了他们的公益计划，可以对于开源项目完全免费，目前已经通过了，我简单体验了一下，和飞书一样都很简洁，比起飞书的优势在于

• 可以绑定域名，
• 每个知识库，每个页面都可以自定义一个 slug，如果不自定义，就是转拼音。
• 可以给组织设置一个默认知识库，例如有多个知识库 zotero-guide， dev-guide 等，设置默认库为 zotero-guide，假设绑定域名 doc.zotero-chinese.com ，则访问 doc.zotero-chinese.com 时是自动跳转到 doc.zotero-chinese.com/zotero-guide 。对应飞书是一串自动生成的后缀，如果只记域名 w6zjinn49j.feishu.cn 会要求登录。
• 可以导出为 markdown ，并与 github 双向同步。

但劣势也很明显：

• 国内访问速度，我关掉梯子试了试，速度是有下降的，在测速网站测得结果，虽然都可以访问，但访问速度相差悬殊，快的不到 1 秒，慢的要多达 5 秒。
• 没有评论

另一个劣势是之前有提到过的需要了解一些 pr ，但是用过之后感觉这个还好，在网页端编辑，区别只是要点一下“edit”，编辑完要点一下“merge”，点 edit 时，gitbook 会自动创建一个 pr，保存时自动合并，倒是不需要命令。

gitbook 预览地址：https://zotero-chinese.gitbook.io/

也看了看语雀，本来看着语雀官方的页面 https://www.yuque.com/yuque 这种很不错，但是我愣是没找着怎么开启这个页面，并且语雀不如飞书简洁，所以放弃了。

也就是如果没有其他选项，我们可以在飞书和 gitbook 里选一个。如果我们确定要买域名，那可以考虑 gitbook，如果不买，那飞书已经满足了我们的需求。

目前文档主要在 GitHub 和 飞书 两个地方，大家可以决定一下，可能的话，可以把文档迁移到一个地方维护。

大家有什么想法嘛？

[windingwind]

看了下语雀，如果要团队的知识库“所有人可见”，需要付费or以非赢利组织形式申请。

[windingwind]

Better Notes插件的用户文档已经完成，目前放在飞书平台。
https://w6zjinn49j.feishu.cn/wiki/space/7132878100186087428?ccm_open_type=lark_wiki_spaceLink

[windingwind]

Zotero插件的开发者文档正在锐意组织中。飞书平台链接：
https://w6zjinn49j.feishu.cn/wiki/space/7133163790413185052?ccm_open_type=lark_wiki_spaceLink

目前完成了大致框架，还待后续补充内容

[windingwind]

@zotero-cn/all
Zotero插件的开发者文档已经完成编写，感谢@l0o0 @iShareStuff 的文档编写工作！
后续可待cn组织的网站建立后合并到一起。

[windingwind]

插件开发文档增加bootstrap模式的相关内容。

[windingwind]

zotero插件框架模板已经公开在https://github.com/windingwind/zotero-addon-template

[windingwind]

另，下一阶段计划将现有的关于Zo使用的常见问题的最新的解答整理到飞书文档，方便搜索，与上述几个文档一起。飞书地址：https://w6zjinn49j.feishu.cn/wiki/space/7134644190071242780?ccm_open_type=lark_wiki_spaceLink

[windingwind]

那倒是不要紧，就这样先弄起来再说了

[windingwind]

已完成快速上手章节。关于引用于CSL方面，我不是特别熟悉，还要麻烦其他朋友帮忙撰写完善。我接下来主要将整理搬运常见问题方面的文档。

[zepinglee]

已完成快速上手章节。关于引用于CSL方面，我不是特别熟悉，还要麻烦其他朋友帮忙撰写完善。我接下来主要将整理搬运常见问题方面的文档。

我去看一下。

[windingwind]

已完成同步章节与相关常见问题。

[windingwind]

已完成快速上手章节。关于引用于CSL方面，我不是特别熟悉，还要麻烦其他朋友帮忙撰写完善。我接下来主要将整理搬运常见问题方面的文档。

我去看一下。

主要是与CSL相关的一些内容，可能可以放进常见问题章节（例如，最典型的怎样利用CSL仓库查找自己需要的样式，怎样编辑，等等）

[windingwind]

@northword

[northword]

收到