From f4599719dc94d236601577198757f9121799ba2d Mon Sep 17 00:00:00 2001 From: Typogalaxy <136544101+Typogalaxy@users.noreply.github.com> Date: Tue, 2 Jun 2026 21:36:23 +1000 Subject: [PATCH] docs(contributors): add product design guide --- docs/contributors/docs/index.en.md | 3 +- docs/contributors/docs/index.zh.md | 1 + docs/contributors/docs/product/articles.en.md | 81 +++++++++++++++++++ docs/contributors/docs/product/articles.zh.md | 81 +++++++++++++++++++ .../contributors/docs/product/community.en.md | 62 ++++++++++++++ .../contributors/docs/product/community.zh.md | 62 ++++++++++++++ .../contributors/docs/product/discovery.en.md | 24 ++++++ .../contributors/docs/product/discovery.zh.md | 24 ++++++ docs/contributors/docs/product/index.en.md | 48 +++++++++++ docs/contributors/docs/product/index.zh.md | 48 +++++++++++ .../docs/product/moderation.en.md | 37 +++++++++ .../docs/product/moderation.zh.md | 37 +++++++++ .../docs/product/open-questions.en.md | 44 ++++++++++ .../docs/product/open-questions.zh.md | 44 ++++++++++ docs/contributors/docs/product/roles.en.md | 19 +++++ docs/contributors/docs/product/roles.zh.md | 19 +++++ docs/contributors/mkdocs.yml | 9 +++ 17 files changed, 642 insertions(+), 1 deletion(-) create mode 100644 docs/contributors/docs/product/articles.en.md create mode 100644 docs/contributors/docs/product/articles.zh.md create mode 100644 docs/contributors/docs/product/community.en.md create mode 100644 docs/contributors/docs/product/community.zh.md create mode 100644 docs/contributors/docs/product/discovery.en.md create mode 100644 docs/contributors/docs/product/discovery.zh.md create mode 100644 docs/contributors/docs/product/index.en.md create mode 100644 docs/contributors/docs/product/index.zh.md create mode 100644 docs/contributors/docs/product/moderation.en.md create mode 100644 docs/contributors/docs/product/moderation.zh.md create mode 100644 docs/contributors/docs/product/open-questions.en.md create mode 100644 docs/contributors/docs/product/open-questions.zh.md create mode 100644 docs/contributors/docs/product/roles.en.md create mode 100644 docs/contributors/docs/product/roles.zh.md diff --git a/docs/contributors/docs/index.en.md b/docs/contributors/docs/index.en.md index f2dac23..851d4e2 100644 --- a/docs/contributors/docs/index.en.md +++ b/docs/contributors/docs/index.en.md @@ -2,7 +2,7 @@ Welcome to the official documentation of **AlienCommons**. -**AlienCommons** is a website currently designed to host documents and articles +**AlienCommons** is a website currently designed to host documents and articles translated by _**LazyAlienServer techMC Translation Team**_. --- @@ -11,5 +11,6 @@ translated by _**LazyAlienServer techMC Translation Team**_. If you are new to this project, start from the following links: +- [Product Design](product/index.en.md) - [Development Setup](development/setup.en.md) - [Project Architecture](architecture.en.md) diff --git a/docs/contributors/docs/index.zh.md b/docs/contributors/docs/index.zh.md index efd9edb..7e5d2cd 100644 --- a/docs/contributors/docs/index.zh.md +++ b/docs/contributors/docs/index.zh.md @@ -10,5 +10,6 @@ 如果你第一次接触这个项目,请从以下链接开始: +- [产品设计](product/index.zh.md) - [开发设置](development/setup.zh.md) - [项目架构](architecture.zh.md) diff --git a/docs/contributors/docs/product/articles.en.md b/docs/contributors/docs/product/articles.en.md new file mode 100644 index 0000000..4632161 --- /dev/null +++ b/docs/contributors/docs/product/articles.en.md @@ -0,0 +1,81 @@ +# Columns + +Formal columns are the core content type of AlienCommons. They are suitable for complete technical writing intended for long-term reading. + +## Basic Content + +A column contains: + +- A title +- Body content +- A cover image +- A summary +- One or more authors +- Free-form tags entered by authors + +Whether the summary may be empty is still undecided. Categories and original-language metadata are not currently planned. + +## Body Capabilities + +The body may include: + +- Images +- Code blocks +- Mathematical formulas +- External links +- Video link cards for platforms such as YouTube and Bilibili + +Videos are not directly embedded or uploaded in the body. Video content is displayed only as link cards. + +## Displayed Information + +A column page displays: + +- Publication time +- Last modification time +- View count +- Like count +- Dislike count +- Bookmark count + +## Work States + +The basic publishing flow is: + +```mermaid +stateDiagram-v2 + [*] --> Draft + Draft --> UnderReview: Author submits + UnderReview --> Draft: Author withdraws + UnderReview --> Published: Editor approves + UnderReview --> Draft: Editor rejects with feedback +``` + +Confirmed rules: + +- Editors may leave revision feedback but cannot modify the text directly. +- A rejected work returns to the draft state. +- A work can be deleted only while it is a draft. +- Published works may be revised, but new versions must be reviewed again. +- While a new version is under review, the previous version remains public. +- The new version replaces the public version only after approval. +- A work unpublished by an editor is not deleted. + +The state entered after unpublishing and whether an `Archived` state should be added are still undecided. See [Open Questions](open-questions.en.md). + +## Collections + +Authors may create collections to organize related works into a series. + +Collection rules: + +- A name is required. +- A description and cover image are optional. +- A work may belong to at most one collection. +- The collection creator must be one of the work's authors. +- The collection creator may manually reorder works. +- A collection page displays its creation time, update time, and bookmark count. +- Users may bookmark collections. +- Collections do not have comment sections. + +Management permissions for multi-author works in collections are still undecided. diff --git a/docs/contributors/docs/product/articles.zh.md b/docs/contributors/docs/product/articles.zh.md new file mode 100644 index 0000000..9eed9d4 --- /dev/null +++ b/docs/contributors/docs/product/articles.zh.md @@ -0,0 +1,81 @@ +# 专栏作品 + +正式专栏是 AlienCommons 的核心内容类型。它适合完整、长期可读的技术表达。 + +## 基本内容 + +一篇专栏作品包含: + +- 标题 +- 正文 +- 封面图 +- 摘要 +- 一位或多位作者 +- 由作者自由填写的标签 + +摘要是否允许为空仍待确定。当前不考虑分类,也不记录原文语言。 + +## 正文能力 + +正文允许插入: + +- 图片 +- 代码块 +- 数学公式 +- 外部链接 +- YouTube、Bilibili 等平台的视频链接卡片 + +正文不直接嵌入或上传视频。视频内容仅以链接卡片形式展示。 + +## 展示信息 + +作品页面显示: + +- 发布时间 +- 最后修改时间 +- 浏览量 +- 点赞数 +- 点踩数 +- 收藏数 + +## 作品状态 + +基础发布流程如下: + +```mermaid +stateDiagram-v2 + [*] --> 草稿 + 草稿 --> 审核中: 作者提交 + 审核中 --> 草稿: 作者主动撤回 + 审核中 --> 已发布: 编辑通过 + 审核中 --> 草稿: 编辑拒绝并给出意见 +``` + +已确认的规则: + +- 编辑可以给出修改意见,但不能直接修改正文。 +- 审核失败后,作品回到草稿状态。 +- 只有处于草稿状态的作品可以删除。 +- 已发布作品可以修改,但新版本需要重新审核。 +- 新版本审核期间,旧版本继续公开展示。 +- 新版本审核通过后,才会替换线上公开版本。 +- 被编辑撤稿的作品不会被删除。 + +撤稿后应进入何种状态,以及是否增加 `Archived` 状态,仍待确定。参见[开放问题](open-questions.zh.md)。 + +## 文集 + +作者可以创建文集(Collection),将自己的相关作品组织成系列。 + +文集规则如下: + +- 名称必填。 +- 简介和封面图可选。 +- 一篇作品最多加入一个文集。 +- 文集创建者必须是文章作者之一。 +- 文集创建者可以手动调整作品顺序。 +- 文集页面展示创建时间、更新时间和收藏数。 +- 用户可以收藏文集。 +- 文集不提供评论区。 + +多人协作作品加入文集后的管理权限仍待确定。 diff --git a/docs/contributors/docs/product/community.en.md b/docs/contributors/docs/product/community.en.md new file mode 100644 index 0000000..7a50071 --- /dev/null +++ b/docs/contributors/docs/product/community.en.md @@ -0,0 +1,62 @@ +# Community Interaction + +AlienCommons provides lightweight community interaction in addition to formal columns. Community features should support technical exchange without overshadowing columns as the platform's core content. + +## Work Interactions + +Users can interact with formal columns by: + +- Liking or disliking +- Bookmarking +- Commenting and replying +- Following authors +- Reporting + +## Community Posts + +Signed-in users may publish community posts. Similar to YouTube community posts, they support lighter and more immediate updates instead of the complete discussion expected from formal columns. + +- Short and medium-length content is allowed. +- The length limit is tentatively around `500` words and remains undecided. +- Images may be attached. +- Likes, dislikes, comments, replies, and reports are supported. +- Bookmarking is not supported. +- There is currently no site-wide community feed. +- A user's community posts are viewed through a dedicated tab on that user's profile. + +## Comments + +Columns and community posts share the same comment system. + +- Comments and replies both support likes, dislikes, and reports. +- Replies may be nested in the data model. +- The interface displays a consistent two-level structure similar to Bilibili. +- Further replies to second-level comments use `@username` instead of additional visual indentation. +- A column author or community-post author may pin one comment. +- Users may edit or delete their own comments. +- Edited comments display an `edited` indicator. +- Comments display their publication time. + +## User Profiles + +A user profile displays: + +- Avatar +- Username +- Biography +- Registration time +- Published columns +- Collections +- Community posts +- Follower count +- Following count + +Users may follow, block, and report other users. + +## Bookmarks and Privacy + +- Every user may create bookmark folders. +- Bookmark folders may contain formal columns from different authors. +- Bookmark folders cannot be nested. +- A bookmark folder may be public or private when created, and its visibility may be changed later. +- Users choose whether their like and dislike history is public. It is private by default. diff --git a/docs/contributors/docs/product/community.zh.md b/docs/contributors/docs/product/community.zh.md new file mode 100644 index 0000000..223ff48 --- /dev/null +++ b/docs/contributors/docs/product/community.zh.md @@ -0,0 +1,62 @@ +# 社区互动 + +AlienCommons 在正式专栏之外提供轻量社区互动。社区功能应服务于技术交流,不应掩盖专栏作品的核心地位。 + +## 作品互动 + +用户可以对正式专栏: + +- 点赞或点踩 +- 收藏 +- 评论与回复 +- 关注作者 +- 举报 + +## 社区帖 + +登录用户可以发表社区帖(Community Post)。它类似 YouTube 社区帖,用于较轻量、较即时的动态交流,不承担正式专栏的完整论述功能。 + +- 允许短内容和中等长度内容。 +- 字数上限暂定约为 `500` 词,具体限制待确定。 +- 允许附带图片。 +- 支持点赞、点踩、评论、回复和举报。 +- 不允许收藏。 +- 当前不设独立的全站社区动态页面。 +- 用户通过个人主页中的专属 Tab 查看某位用户的社区帖。 + +## 评论 + +专栏和社区帖共用同一套评论机制。 + +- 评论和回复都支持点赞、点踩和举报。 +- 数据层允许嵌套回复。 +- 前端统一采用类似 Bilibili 的两级展示结构。 +- 对二级评论的继续回复通过 `@用户名` 表达,不增加新的视觉缩进。 +- 专栏作者或社区帖作者可以置顶一条评论。 +- 用户可以编辑或删除自己的评论。 +- 编辑后的评论显示 `edited` 提示。 +- 评论显示发布时间。 + +## 用户主页 + +用户主页展示: + +- 头像 +- 用户名 +- 个人简介 +- 注册时间 +- 已发布专栏 +- 文集 +- 社区帖 +- 关注者数量 +- 正在关注的人数 + +用户之间可以关注、拉黑和举报。 + +## 收藏与隐私 + +- 每位用户都可以创建收藏夹(Bookmark Folder)。 +- 收藏夹可以收录不同作者的正式专栏作品。 +- 收藏夹不允许嵌套。 +- 收藏夹创建时可以选择公开或私密,之后可以随时调整。 +- 点赞与点踩记录是否公开由用户自行选择,默认不可见。 diff --git a/docs/contributors/docs/product/discovery.en.md b/docs/contributors/docs/product/discovery.en.md new file mode 100644 index 0000000..45975a3 --- /dev/null +++ b/docs/contributors/docs/product/discovery.en.md @@ -0,0 +1,24 @@ +# Content Discovery + +Users can discover columns through the home-page recommendation feed and search. + +## Home-Page Recommendations + +The home page centers on a work recommendation feed. Its discovery experience may draw from Bilibili and YouTube, but only formal columns are recommended. + +- Collections and community posts are not mixed into the home page. +- Visitors and signed-in users can both view the recommendation feed. +- Visitors receive random recommendations. +- Signed-in users receive personalized recommendations. + +The specific recommendation algorithm is outside the scope of this product document. + +## Search + +Search is used only to discover columns. + +- Search results support filtering. +- Search results support sorting. +- The specific filter and sort options are still undecided. + +Collections, users, and community posts are not currently included in search. diff --git a/docs/contributors/docs/product/discovery.zh.md b/docs/contributors/docs/product/discovery.zh.md new file mode 100644 index 0000000..92bf06c --- /dev/null +++ b/docs/contributors/docs/product/discovery.zh.md @@ -0,0 +1,24 @@ +# 内容发现 + +用户可以通过首页推荐流和搜索发现专栏作品。 + +## 首页推荐 + +首页以作品推荐流为核心,体验可以参考 Bilibili 和 YouTube,但推荐对象仅为正式专栏作品。 + +- 首页不混入文集或社区帖。 +- 游客和已登录用户都可以看到推荐流。 +- 游客看到随机推荐。 +- 已登录用户看到个性化推荐。 + +具体推荐算法不在当前产品文档中约束。 + +## 搜索 + +搜索仅用于发现专栏作品。 + +- 搜索结果支持筛选。 +- 搜索结果支持排序。 +- 具体筛选项和排序项仍待确定。 + +文集、用户和社区帖当前不属于搜索范围。 diff --git a/docs/contributors/docs/product/index.en.md b/docs/contributors/docs/product/index.en.md new file mode 100644 index 0000000..d4c2815 --- /dev/null +++ b/docs/contributors/docs/product/index.en.md @@ -0,0 +1,48 @@ +# Product Positioning + +AlienCommons is a column publishing platform for Technical Minecraft players. It encourages players to record, discuss, and share Minecraft technical knowledge in written, formal, and moderately academic forms. + +## Why AlienCommons Exists + +The Minecraft community already communicates through forums, Discord groups, video and streaming platforms, wikis, and other channels. AlienCommons is not intended to replace them. It provides a format better suited to complete arguments and long-term reading. + +Written columns have several advantages: + +- They are suitable for presenting opinions, inventions, discoveries, and research results systematically. +- They are easier to preserve, cite, and organize over time. +- Compared with real-time chat or video content, they are easier to translate and can help technical communities communicate across languages. + +Built-in translation features are still under consideration. Whether or not the website provides translation tools, translatability is one reason the platform emphasizes written content. + +## Content Scope + +The platform welcomes technical Minecraft content, including but not limited to: + +- Redstone circuits, survival engineering, and gameplay involving engineering, mathematics, or computer science. +- In-depth investigation of game mechanics, such as modeling arrow motion in Minecraft. +- Community projects such as mods, data packs, shaders, plugins, and launchers. +- Architecture in Minecraft. +- Opinions, introductions, inventions, discoveries, and more complete research results on technical topics. + +## Target Users + +AlienCommons primarily serves two groups: + +- Readers who want to learn more about Minecraft game knowledge. +- Creators who want to publish their results and views in formal or semi-academic forms. + +## Product Principles + +- **Columns come first.** Formal works are the core of the platform. The home page and search are designed around columns. +- **Encourage rigorous writing.** The platform should support complete discussion instead of focusing only on immediate interaction. +- **Preserve readability.** Discovery experiences may draw from established content platforms, while the interface should remain clear and suitable for reading columns. +- **Separate formal and lightweight content.** Community posts support lighter updates and should not replace formal columns. + +## Continue Reading + +- [User Roles](roles.en.md) +- [Columns](articles.en.md) +- [Content Discovery](discovery.en.md) +- [Community Interaction](community.en.md) +- [Reports and Administration](moderation.en.md) +- [Open Questions](open-questions.en.md) diff --git a/docs/contributors/docs/product/index.zh.md b/docs/contributors/docs/product/index.zh.md new file mode 100644 index 0000000..3546e93 --- /dev/null +++ b/docs/contributors/docs/product/index.zh.md @@ -0,0 +1,48 @@ +# 产品定位 + +AlienCommons 是一个面向 Minecraft 技术向玩家(Technical Minecraft players)的专栏发布平台。它鼓励玩家以书面化、正式化和适度学术化的方式记录、讨论和传播 Minecraft 技术知识。 + +## 为什么需要 AlienCommons + +Minecraft 社区已经存在论坛、Discord 群组、视频与直播平台、Wiki 等多种交流方式。AlienCommons 不试图取代这些平台,而是提供一种更适合完整论述和长期阅读的表达形式。 + +书面专栏具有以下优势: + +- 适合系统地介绍观点、发明、发现和研究成果。 +- 便于长期保存、引用和整理。 +- 相比即时聊天或视频内容,更容易翻译,有助于不同语言社区之间交流技术成果。 + +内置翻译功能仍在考虑中。无论网站是否提供翻译工具,方便翻译都是平台重视书面内容的原因之一。 + +## 内容范围 + +平台欢迎与 Minecraft 有关的技术性内容,包括但不限于: + +- 红石电路、生存工程,以及涉及工程、数学或计算机科学的玩法。 +- 对游戏机制的深入研究,例如为 Minecraft 中的箭矢运动建立模型。 +- 模组、数据包、光影、插件、启动器等社区作品。 +- Minecraft 中的建筑学。 +- 对技术主题的观点、简介、发明、发现和较完整的研究成果。 + +## 目标用户 + +AlienCommons 主要服务于两类用户: + +- 希望深入了解 Minecraft 游戏知识的读者。 +- 希望以正式或半学术化方式发表成果和见解的创作者。 + +## 产品原则 + +- **专栏优先。** 正式作品是平台的核心,首页和搜索都围绕专栏设计。 +- **鼓励严谨表达。** 平台应支持较完整的论述,而不是只追求即时互动。 +- **保持可读性。** 页面设计可以借鉴成熟内容平台的发现体验,但应保留清晰、适合阅读的专栏气质。 +- **区分正式与轻量内容。** 社区帖用于较轻量的动态交流,不应替代正式专栏。 + +## 继续阅读 + +- [用户角色](roles.zh.md) +- [专栏作品](articles.zh.md) +- [内容发现](discovery.zh.md) +- [社区互动](community.zh.md) +- [举报与管理](moderation.zh.md) +- [开放问题](open-questions.zh.md) diff --git a/docs/contributors/docs/product/moderation.en.md b/docs/contributors/docs/product/moderation.en.md new file mode 100644 index 0000000..a50476d --- /dev/null +++ b/docs/contributors/docs/product/moderation.en.md @@ -0,0 +1,37 @@ +# Reports and Administration + +AlienCommons separates editorial responsibilities from high-risk site administration permissions. + +## Editor Responsibilities + +Editors are responsible for the column publishing workflow: + +- Review user submissions. +- Approve or reject submissions. +- Leave revision feedback for authors. +- Unpublish works that have already been published. + +Editors cannot directly modify an author's text, and review permissions do not automatically grant high-risk capabilities such as banning users. + +## Reports + +The following objects should all be reportable: + +- Columns +- Community posts +- Comments +- Users +- Collections + +Reports for the first four object types are currently implemented. Collection reports remain to be implemented. + +When submitting a report: + +- A reason is required. +- Additional details may be provided. + +## Penalties + +- Who handles reports is still undecided. +- User penalty rules are still undecided. A tiered penalty system is currently preferred. +- Previously published columns remain public when their author receives a penalty. diff --git a/docs/contributors/docs/product/moderation.zh.md b/docs/contributors/docs/product/moderation.zh.md new file mode 100644 index 0000000..120e80a --- /dev/null +++ b/docs/contributors/docs/product/moderation.zh.md @@ -0,0 +1,37 @@ +# 举报与管理 + +AlienCommons 将作品编辑职责与高风险站务权限分开。 + +## 编辑职责 + +编辑(Editor)负责专栏发布流程: + +- 审核用户提交的作品。 +- 通过或拒绝投稿。 +- 为作者留下修改意见。 +- 撤下已经发布的作品。 + +编辑不能直接修改作者正文,也不会因为拥有审核权限而自动获得封禁用户等高风险权限。 + +## 举报 + +以下对象都应允许被举报: + +- 专栏 +- 社区帖 +- 评论 +- 用户 +- 文集 + +当前已经实现前四类对象的举报。文集举报仍待实现。 + +提交举报时: + +- 必须选择举报原因。 +- 可以填写补充说明。 + +## 处罚 + +- 举报由谁处理仍待确定。 +- 用户处罚规则仍待确定,目前倾向采用分级处罚。 +- 用户受到处罚后,其已经发布的专栏继续公开展示。 diff --git a/docs/contributors/docs/product/open-questions.en.md b/docs/contributors/docs/product/open-questions.en.md new file mode 100644 index 0000000..be693e1 --- /dev/null +++ b/docs/contributors/docs/product/open-questions.en.md @@ -0,0 +1,44 @@ +# Open Questions + +This page collects product decisions that remain undecided. Contributors should not treat them as confirmed implementation requirements. + +## Columns + +- May the summary be empty? +- Which state should a published work enter after an editor unpublishes it? +- Should an `Archived` state be added? +- Which transitions should be allowed between states? + +## Collections + +- After a multi-author work is added to a collection, should co-authors other than the collection creator have management permissions? + +## Search + +- Which filters should search results provide? +- Which sort options should search results provide? + +## Community Posts + +- What should the exact community-post length limit be? It is tentatively around `500` words. + +## Administration + +- Which role should handle reports? +- Which levels and restrictions should a tiered penalty system include? +- Should the community-administrator role be enabled? If so, what are its responsibilities and permissions? + +## Notifications + +The notification system as a whole remains undecided, including but not limited to: + +- Column approval, rejection, or unpublishing. +- Comments on columns or community posts. +- Replies to comments. +- Received likes or dislikes. +- New followers. +- Report outcomes. + +## Translation + +- Should the website provide built-in translation features? diff --git a/docs/contributors/docs/product/open-questions.zh.md b/docs/contributors/docs/product/open-questions.zh.md new file mode 100644 index 0000000..eff79f6 --- /dev/null +++ b/docs/contributors/docs/product/open-questions.zh.md @@ -0,0 +1,44 @@ +# 开放问题 + +本文汇总尚未确定的产品决策。协作者不应将这些内容视为已经确定的实现要求。 + +## 专栏 + +- 摘要是否允许为空? +- 已发布作品被编辑撤稿后,应进入什么状态? +- 是否需要增加 `Archived` 状态? +- 各状态之间允许哪些转换? + +## 文集 + +- 多人协作作品加入文集后,除文集创建者之外的共同作者是否拥有管理权限? + +## 搜索 + +- 搜索结果应提供哪些筛选项? +- 搜索结果应提供哪些排序方式? + +## 社区帖 + +- 社区帖的具体长度限制是多少?当前暂定约为 `500` 词。 + +## 管理 + +- 举报由哪类角色处理? +- 分级处罚具体包括哪些等级和限制? +- 社区管理员是否需要启用?如果启用,其职责和权限是什么? + +## 通知 + +通知系统整体待定,包括但不限于: + +- 专栏审核通过、拒绝或被撤稿。 +- 专栏或社区帖收到评论。 +- 评论收到回复。 +- 收到点赞或点踩。 +- 新增关注者。 +- 举报处理结果。 + +## 翻译 + +- 网站是否需要提供内置翻译功能? diff --git a/docs/contributors/docs/product/roles.en.md b/docs/contributors/docs/product/roles.en.md new file mode 100644 index 0000000..68aca9f --- /dev/null +++ b/docs/contributors/docs/product/roles.en.md @@ -0,0 +1,19 @@ +# User Roles + +AlienCommons should distinguish basic user identities from responsibility-based permissions. Every signed-in user may publish works without applying to become a column author first. + +| Role | Definition | Main Capabilities | +| --- | --- | --- | +| Visitor | A user who is not signed in | Browse public content and view a random recommendation feed | +| Regular user | A signed-in user | Publish works and use regular community features | +| Column author | A regular user who has published or is preparing a work | No essential permission difference from a regular user; this is closer to a creator identity | +| Editor | A user responsible for reviewing works | Review submissions, leave revision feedback, and unpublish works; cannot edit an author's text directly | +| Community administrator | A selected user who assists with community maintenance | Role design is undecided and currently deferred | +| Official administrator | A staff member with high-risk administrative permissions | For example, banning users and performing other site operations | + +## Permission Boundaries + +- Editors and official administrators are separate roles. +- Review permissions do not automatically grant editors high-risk permissions such as banning users. +- Editors may leave revision feedback but cannot directly modify an author's text. +- The responsibilities and permissions of community administrators are still undecided and are not a current-version requirement. diff --git a/docs/contributors/docs/product/roles.zh.md b/docs/contributors/docs/product/roles.zh.md new file mode 100644 index 0000000..9d1b88b --- /dev/null +++ b/docs/contributors/docs/product/roles.zh.md @@ -0,0 +1,19 @@ +# 用户角色 + +AlienCommons 的权限设计应区分基础用户身份与职责型权限。所有已登录用户都可以发表作品,不需要先申请成为专栏作者。 + +| 角色 | 定义 | 主要能力 | +| --- | --- | --- | +| 游客 | 未登录用户 | 浏览公开内容,查看随机推荐流 | +| 普通用户 | 已登录用户 | 发布作品,使用常规社区功能 | +| 专栏作者 | 已发表或准备发表作品的普通用户 | 与普通用户没有本质权限差异,更接近内容创作者身份 | +| 编辑(Editor) | 负责作品审核的用户 | 审核投稿、给出修改意见、撤稿;不能直接修改作者正文 | +| 社区管理员 | 被选中协助维护社区秩序的用户 | 角色设计待定,当前搁置 | +| 官方管理员 | 拥有高风险管理权限的站方人员 | 例如封禁用户和执行其他站务操作 | + +## 权限边界 + +- 编辑与官方管理员是不同角色。 +- 编辑不因为拥有审核权限而自动获得封禁用户等高风险权限。 +- 编辑可以为投稿留下修改意见,但不能直接修改正文。 +- 社区管理员的职责与权限仍待确定,不属于当前版本要求。 diff --git a/docs/contributors/mkdocs.yml b/docs/contributors/mkdocs.yml index 594abc1..351a562 100644 --- a/docs/contributors/mkdocs.yml +++ b/docs/contributors/mkdocs.yml @@ -4,6 +4,14 @@ site_url: https://lazyalienserver.github.io/alien-commons/ nav: - Home: index.md - Overview: overview.md + - Product: + - product/index.md + - product/roles.md + - product/articles.md + - product/discovery.md + - product/community.md + - product/moderation.md + - product/open-questions.md - Architecture: architecture.md - Development: - development/setup.md @@ -30,5 +38,6 @@ plugins: nav_translations: Home: 首页 Overview: 概览 + Product: 产品设计 Architecture: 架构 Development: 开发