Skip to content

Liphael/Compass

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 

Repository files navigation

指南针 Compass

ver: 0.1.0-alpha

上次更新:更新-指南针架构基本模板

Latest update: update-Basic Template of Compass stucture

结构 Structure

  • 纯粹分类 pure-classification

    上级:分类学

    Superior: Taxonomy

    同级:数据库结构设计(暂定)

    Level: Database structure design(tentative)

    下级:Null(tentative)

    Subordinate: null(tentative)

  • 模块属性 modulization

    前置:分类学,哲学

    Prerequisite: Taxonomy,Philosophy

    同类:Null(tentative)

    Homotype: null(tentative)

    附属:Null(tentative)

    belongling: null(tentative)

定义 Definition

知识库构建指导:“Compass”架构

Repository construction guidance: “Compass” Structure

用途 Usage

指南针架构的意图,是在依据更高普遍性(蕴含抽象性)的逻辑基础上,建立起易抽象性更好的知识库体系。其中,更高普遍性的意义在于:同样的对象和符号,能在不同的使用者手中同样地解读,并且所有人都能理解其编辑规则,共同进行库的丰富和整理;易抽象性的意义在于:对于高度统一、高度抽象的概念,库读者可以迅速找到其具象化的方法,或对应的案例,以此与自身使用需求对接。

从此出发,指南针架构的发展方向应当是:逻辑(结构)层次严谨而简明的,抽象具象两极化且内容和谐相生的,以相对固定流程为基础、开源可个性化为延展的。

The intention of the compass architecture is to establish a knowledge base system that is easier to abstract based on a logical foundation of higher universality (containing abstraction). The significance of higher universality lies in the fact that the same objects and symbols can be interpreted equally by different users, and everyone can understand their editing rules to enrich and organize the library together; The significance of abstractness lies in the fact that for highly unified and abstract concepts, library readers can quickly find ways to concretize them or corresponding cases to match their own usage needs.

From this point on, the development direction of the compass architecture should be: a logical (structural) hierarchy that is rigorous and concise, abstract and concrete that is polarized and harmonious in content, based on relatively fixed processes, and open source and customizable as extensions.

使用教程 Tutorial

申明必要概念 Declaration of necessary concepts

为了避免产生不必要的疑惑,在此申明一些必要的概念,以提供使用者在首次尝试使用Compass撰写知识单位页面时、可能所需的参照。

To avoid unnecessary confusion, some necessary concepts are hereby declared to provide users with references they may need when attempting to write a knowledge unit page using Compass for the first time.

单位:一个物件对象,或事件对象,或方法对象。这也是库结构中,每个子项的标题,是所记录知识对象的总标题。

Unit: an object, or event, or method. This is also the title of each sub-item among the repository, and the overall title of the knowledge object u want to record.

单位页面:这个对象的详细信息页面。这是在库中对该对象展开详细描述和知识记录的页面,是指南针架构的应用处。

Unit Page: Detailed description page of the unit. This is a page that provides a detailed description and knowledge record of the object in the library, where Compass Structure about to be applied.

两个主要要素:意义和合理性。

确保每个单元的副标题,都是单元的高级抽象部分;解释意义,并诠释其合理性。

副标题的内容,建议分为两类:一类是高度抽象的、象征性的;另一种是对抽象事物的实际描述和解释。

two main elements: meaning & rationality.

ensure every subtitle of the unit, is a high level abstract part of the unit; explaining the meaning, providing rationality.

the content of the subtitle, is recommended to be two types of parts: one highly abstract, symbolized; another is practical description, explaination of the abstract things.

基本结构 Basic structure

以下为Compass架构下,单位页面的基本内容:

  1. 结构
    结构部分应当由两个系列组成,即纯粹分类模块属性
    1. 纯粹分类:纯粹分类为你的总目录分级服务,应当严格服从总目录的分级分类;这是为了自下而上的顺序、以及追根溯源夯实知识基础的需要准备的。
    2. 模块属性:模块属性中将展示学习和理解该单位(对象)可能所需的前置要求,同类替代以及可选的拓展等;这是为了自上而下学习顺序、以及实际应用产生的灵活需求准备的。
  2. (官方/公认)指导文件(或链接)
    当单位页面不值得花费更多精力来陈列不必要的信息,指导文件的链接可以方便提供额外的参考。
  3. 抽象定义
    此为抽象具象两极(以下简称两级)中抽象的极端;
    应当追求逻辑严密和统一化下,最精炼的符号表达。
    它的意义在于:能熟练运用该抽象定义时,用于简化描述实际问题,寻找同质性和提高处理问题效率。
  4. 抽象性质
    是基于上述抽象定义,对该对象的性质进行的符号化描述。
  5. 辅以实际案例的详细说明
    两极中具象的一极。事实上,抽象定义和抽象性质均来自于人对实际案例的总结过程(抽象过程);
    这通常会是一个循环上升、依靠量来逐步优化的过程,很少能一蹴而就。
    因此,附录一些实际案例来辅助说明是必要的;
    此外,抽象定义和性质通常为作者所熟悉、对读者来说很陌生,辅以实际案例的说明才能优化读者的理解。
  6. 辅以实际案例的应用
    辅以实际案例的详细说明用实际案例佐证该对象的性质,这里则给出应用的实际案例。

The following is the basic content of the Unit Page under the Compass architecture:

  1. structure
    The structural part should consist of two series, namely pure classification & modulization.
    1. Pure classification: pure classification service for the general directory classification, it should strictly comply with the classification of the general directory. This is prepared for the bottom-up learning sequence, and the need to trace back and solidify the knowledge foundation.
    2. modulization: modulization displays the prerequisite requirements, similar substitutions, and optional extensions that may be needed to grasp the unit (object). This is prepared for the top-down learning sequence, and flexible requirements generated by practical applications.
  2. (Official/Recognized) Guidance Doc(or links)
    when the Unit Page is not worth investing in displaying unnecessary information, the links to other Tutorial can provide additional references conveniently.
  3. Abstract Definition(Def)
    this is the abstract pole of the two poles of abstraction and concreteness(poles);
    the most refined symbol expression, under logical rigor and uniformity, is what should be pursued.
    significance lies in: able to proficiently apply this Def to simplify the description of cases, find homogeneity among cases, thus improve efficiency.
  4. Abstract Properties
    symbolic descriptions of the properties of the object, based on Def above.
  5. Detailed explanation supplemented by practical cases
    the concrete pole of the poles. In fact, Def and abstract properties both come from summarization of actual cases(abstraction);
    this is usually a cyclical process that relies on quantity to gradually optimize, rarely can be accomplished at one stroke.
    thus necessary to provide some practical cases for explaination supplement;
    Def and abstract properties are often familiar to authors, but unfamiliar to readers. Just enhance the readers' understanding through practical case studies.
  6. Application supplemented by practical cases
    here u can present a practical application case as a exemplary role.

开源许可 License

The MIT License (MIT): https://opensource.org/license/mit/