关于 Laravel 文档的建议

分享 / 1094 / 8 / 创建于 4年前 / 更新于 4年前

我感觉有时候，其实我们不大理解文档的意思，如果能增加一个类似标注的功能，可以允许大家对文档的某些地方进行解读，类似于 PHP 官方文档那样，这样子大家也更能文档的意思同时能进行交流补充文档。
允许对文档内容进行搜索。

文档 laravel

miaotiao

课程读者 60 声望

我是一个粉刷匠~粉刷本领强~我要把那新房子，刷得很漂亮~

0 人点赞

我们将带你从零开发一个项目并部署到线上，本课程教授 Web 开发中专业、实用的技能，如 Git 工作流、Laravel Mix 前端工作流等。

你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程，JWT 概念及使用和 API 开发相关的进阶知识。

推荐文章：

更多推荐...

博客

Laravel 11 中文文档仓库，已翻译完成！！！ 16 / 28 |

博客

Laravel验证器最完整用法实例 31 / 14 |

博客

PHP Annotated——2023 年 12 月 25 / 2 |

分享创造

使用 Laravel 10 & Vue 3 开发了一个社区站，一起来玩下～ 17 / 39 |

博客

历时一个月，《穿透Laravel》全书完成！ 88 / 25 |

博客

[开源项目] 基于 laravel 开发的一个社区/社交小程序 23 / 47 |

讨论数量: 8

Summer

站长 11.3k 声望 / 维护者 @ LearnKu.com

划词标注的功能倒是不错，考虑后面加到文档系统里，不过这块功能好多地方没想明白，例如文章是会修改的你划的词，如果刚好被改掉以后，该怎么办

4年前评论

miaotiao （楼主）

这的确是个问题，我暂时也没想太明白

刚发现的腾讯云文档的功能 https://cloud.tencent.com/document/product...

dinghua

@生活无限好这个只能反馈问题，和文档标注不一样

鸡排饭加蛋

课程读者 109 声望 / PHP搬运工 @ 厦门

我觉得文档下面对应可以评论就挺好，对应章节有什么不懂的，大家都可以在下面进行讨论

4年前评论

miaotiao （楼主）

嗯嗯，现在是挺不错的。但是查询起来感觉还是稍微有点不如意。哈哈哈哈

鸡排饭加蛋（作者）

@miaotiao 文档查询可以在顶部的搜索框直接搜索不是？

Summer

站长 11.3k 声望 / 维护者 @ LearnKu.com

给个链接，截个屏我瞧瞧

4年前评论

s51983

建议有特定含义的单词不要翻译成中文，保持英文即可。如： Service Container Service Providers guards providers 翻译成中文之后对于新手来讲和代码对应不到一起去，会产生困惑。

风吹过有夏天的味道

我之前用微信读书，上面可以下划线标记某段，然后写自己的感想，而且可以看到别人写的感想，这种我觉得就挺好

miaotiao （楼主）

@风吹过有夏天的味道我最近也在用微信读书，我感觉微信读书这个形式更适用于很多人对文章任意位置进行选中评论这种场景。而技术文档并不太适用于这种场景。毕竟我们也只是对文档的某一小主题进行解读而已，而且这种解读只是针对小部分晦涩难懂，容易歧义的主题。其次我们的这种解读最好是能直接显示出来，而不用像微信读书那样还需要再次点击才能查看到内容才行。最后，这个技术上感觉要复杂很多。

miaotiao

课程读者 60 声望

https://www.php.net/manual/en/function.arr...
类似于可以展示一大块相关主题的内容，这样子会不会好一些
file

4年前评论

小李世界

感觉这个比较一般，我觉得像维基百科的的还行，移动鼠标到文字上，会有 Modal 出来，显示一些信息。点击选项，开启批注；Modal 可以弄成也是多人共同编辑的那样。

Summer

这个只是评论，然后做个排序。之前社区文档里也是这种形式，不过因一方面排版太乱，另一方面不方便讨论，就改成现在这种一个文档文章对应无数讨论帖的模式

miaotiao （作者）（楼主）

@likunyan 为什么我的维基百科为没有 modal 出来，能给个连接让我看看吧。😂

miaotiao （作者）（楼主）

@Summer 如果将文档的每个大主题下面的每个小主题单独作为一个页面，我们可以在该页面上对该小主题进行评论，这样也更精准一点

Summer

@miaotiao 现在不就是这样？

miaotiao （作者）（楼主）

@Summer 只能看到评论的题目啊，对于评论里面的内容不清楚。每个评论所属的文章主题感觉有点点大了，再细分一下是不是好一些

miaotiao

课程读者 60 声望

@linxb 你说的是这个搜索么？

file

4年前评论

鸡排饭加蛋

课程读者 109 声望 / PHP搬运工 @ 厦门

@miaotiao 是的

4年前评论

miaotiao （楼主）

这个搜索的范围太大了，最好能只在每一个文档内部的有一个全文搜索。感觉效果更棒，比如： https://www.kancloud.cn/manual/thinkphp6_0...

UpGod

66 声望

标注功能确实很棒,就像起点小说里的评论一样! 标注修改的话,可以提示同步修改历史标注的关键字, 拿位置和字同步确认,这样应该可以达到精准吧

4年前评论

miaotiao （楼主）

哈哈哈，这个实现感觉也很不错。

方圆十三

课程读者 6 声望

我觉得搜索范围需要限制一下

4年前评论

miaotiao （楼主）

确实是~

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容，与人为善，比聪明更重要！

帮助

关于 Laravel 文档的建议

推荐文章：

社区赞助商

关于 LearnKu

资源推荐

服务提供商

其他信息

关于 Laravel 文档的建议

推荐文章：

社区赞助商

关于 LearnKu

资源推荐

服务提供商

其他信息

请登录