Nop 社区与官网

本文档为只读状态,欢迎有想法的人查看飞书云文档版本并批注评论。😄😄😄

Nop 平台canonical 自创的可逆计算理论的代码实现,提供新的软件构造原理的某种元机制和元工具,是一种比较纯粹的「引擎」,并不直接提供对于一线业务开发人员友好的功能。

其创作者是一个不为世俗之事所扰且具有科研人员气质的理想主义者,因而只关心作为底层的 Nop 平台的核心功能,自身不考虑任何商业化发展

鉴于上述原因,注定 Nop 平台在推广使用上会产生很大阻力;但有如此「合理」的软件开发解决方案难能可贵,若不被人知而沉进互联网的汪洋大海中实属可惜!

为了避免产生这种不期望的结果,需要成立社区并搭建官网,吸引认可且看好 Nop 平台的人加入进来,共同建设社区与生态!

需求分析

「Nop 社区」是以「Nop 平台」为根基,由一群有想法、热情和行动力的人共建而来,初期会以 Spring 作为重点参考。

社区与生态

在 Gitee 和 GitHub 上分别建立名为「nop-platform」的组织用于社区化发展,前者主要面向中文圈/国内人员,后者则主要面向非中文圈/海外人员。

Nop 社区大致由以下几类人员构成:

  • 社区共建者——Nop 平台创作者 canonical 及任何归属于「nop-platform」组织的项目的维护者与贡献者;
  • 社区合作者——得到社区团队认可且进行深度合作的第三方个人或组织;
  • 生态共建者——基于 Nop 平台或社区项目开发的第三方项目的维护者与贡献者。

随着社区不断地壮大,必然会有人来通过打赏或赞助等形式资助以支撑社区的健康发展,按资助的对象可分两种情况:

  • 社区本身——资助所得归社区团队,如何对接、分配与利用等具体事宜待「社区运营委员会」成立后再定;
  • 团队成员——资助所得归成员个人,在官网「团队」页面的成员信息中开放通往个人资助页的入口(需成员本人提供)。

官网

官网的主体是「Nop 社区」,而非「Nop 平台」,但「Nop 平台」是「Nop 社区」的重要组成部分。

作为社区的门面,官网的重要性不言而喻。

设计

社区的详细设计需要尚未成立的「社区运营委员会」,因而这部分内容只针对官网。

信息架构

官网的页面结构大体为:

官方网站
├── 首页 ## 官网落地页
├── 学习 ## 入门 Nop 平台
│ ├── 指南 ## 在不深入背后原理的前提下学会使用
│ ├── 文章 ## 有价值的 Nop 相关文章
│ └── 视频 ## 有价值的 Nop 相关视频
├── 项目 ## 社区项目
│ └── Nop 平台 ## 深入 Nop 平台
└── 社区 ## 了解社区
├── 概览
├── 团队
└── Gitee/GitHub 组织

学习资料

指南并非「Nop 平台」这个项目专属,目的是让人了解「Nop 平台」,并在不深入其背后原理的情况下能够结合其他项目开发业务应用。

文章与视频可以是团队成员创作的,也可以是其他人投稿的。

社区项目

理论上每个社区项目都应有各自专用的文档网站,包括项目与原理的详细介绍、API 指引之类;且各文档网站(尽量)采用相同的网站设计(布局、颜色等),以保证体验一致性。

当下「Nop 平台」给人感觉是个巨大的整体,可考虑根据其构成模块能否单独使用拆分出多个「子项目」进行暴露,如 NopReport、NopORM。可参考 Spring Projects

技术选型

指南、教程类文档按照 QiiDB 数据规范编写与组织 Markdown、YAML 等文件;采用基于 SSG 的 Lime 开发网站;利用 KnoSys 将文档源文件转化为 SSG 所需形式。

使用这套方案可以更符合直觉地以 Markdown 编写指南、教程类文档。

网站部署在 Gitee PagesGitHub Pages 上:

语言版本 网址
中文版 https://nop-platform.gitee.io/
英文版 https://nop-platform.github.io/

任务

处理中 (1)

  • 网站或文档源文件变更并提交后自动部署

未开始 (2)

  • 将中文版文档借助工具翻译为英文版初版
  • 训练 Nop 问答助手

已完成 (6)

  • 创建「nop-platform」组织与官网仓库
  • 基于 Jekyll 搭建中、英文网站框架并部署
  • 整理 Nop Entropy 相关文档并部署
  • 添加 Nop Entropy 和 Nop Chaos 项目介绍
  • 搭建项目文档站点脚手架
  • 将 SSG 从 Jekyll 切换到 Hexo