Appropedia 允许多种类型的内容,只要符合愿景和使命即可。本页描述了最常见的类型及其用例。

伯比农场一年生 - 生长最好的种子,包括稀有的新奇事物 (1895) (19889547733).jpg

Appropedia 不是百科全书,而是解决地球问题的知识纲要,主要是从以人类为中心的角度出发:贫困、气候变化、保护、健康、教育等。Appropedia 主要关注开放的专有技术,这意味着知识记录的尝试帮助人们和组织理解、研究和重现行为,以在他们周围的环境中产生效果。

页长

少于 1000 个字符的页面通常被认为太短,并被归类为存根。存根需要扩展,但好的存根仍然很有价值。它们可能包含一个好的定义、一个或多个关键见解和/或非常有价值的链接。

相反,超过 100,000 个字符的页面通常被认为太长。此类页面应汇总或拆分为两个或更多页面。一种有效的方法是将最大的部分移至其自己的页面中,编写良好的引导部分,然后留下摘录

部分

  • 避免级别 1 的部分(带有单个 = 符号)。 1 级应仅保留给页面标题。
  • 避免 5 级或 6 级部分(带有 5 或 6 = 标志)。嵌套太深的部分通常会令人困惑。重组内容以避免它们,或将整个部分移动到新页面并留下摘录

列表

  • 避免嵌套列表超过两层。它们可能会令人困惑,并且在移动设备上看起来不太好。
  • 仅当项目的顺序很重要时才使用有序列表,例如给出分步说明时。否则使用无序列表。

内容类型

Appropedia 也可以被描述为一个技术知识库,因此它多种多样并以不同的方式使用。以下是 Appropedia 上一些最常见的页面类型以及如何在 Appropedia 上找到它们。

主题页面

主题或知识页面通常旨在帮助读者扩展有关特定主题的知识。它们可以传递知识,但它们不是百科全书式的文章。他们必须提供以下信息:

  • 对概念、技术、技能或程序的总体概述。
  • 介绍主题、细分和其他注意事项的一般概念的起点。
  • 文献中的示例和最常见案例列表,包括 Appropedia 上的案例,这些案例可能有助于指导该主题的研究或选择要复制的技术。

读者可以使用主题页面作为有用的资源来探索 Appropedia 上记录的有关技术或过程的各种用例和经验。

结构

检查主题(或知识)页面是否符合以下条件:

  • 所有主题页面必须包含模板:页面数据数据框。
  • 概述(描述主题)
  • Appropedia 上的实例(Appropedia 上的示例列表)。对于设备和项目,您可以使用Template:Search显示图库。

指南

要创建一流的主题页面,请考虑以下因素:

  • 技术考虑因素,例如它们的构建方式、替代方案以及与其使用相关的困难。
  • 文化考虑
  • 环境考虑。
  • 外部文档来源。

撰写基于知识的文章的一些最佳实践是:

  1. 力求简洁——用户正在寻找一个简单的答案,而不是一首诗;
  2. 使阅读更容易 - 通过添加列表、标题和图形来分割长文本块;
  3. 添加资产 - 有时照片、视频或链接会得到更快的响应(考虑使用维基共享资源中的内容);
  4. 测试和优化 - 根据用户反馈重塑内容,直到问题数量减少。

文献综述

文献综述列出了某个主题的来源和评论的摘要。 Appropedia 上的文献评论通常与旨在开发或实施特定方法或技术的特定项目相关。尽管是在研究过程中创建的相当个人(且混乱)的文档,但保存研究过程的文档对于未来的研究人员查找相关文献并理解项目设计决策背后的推理来说是非常有价值的资产。它们是理解特定项目或设计背后的推理并生成将来可以重复使用的可验证信息的宝贵资源。

文献综述是 Appropedians 研究的核心。它涉及寻找原始材料,例如论文、专利和其他二手信息。这是研究人员展示他们正在研究的主题的知识的地方。文献综述是对主题领域现有材料的讨论。因此,需要收集与所选研究领域相关的已发表作品(印刷版或在线版)。

结构

作为项目或设备页面一部分的文献评论必须放置为子页面,例如DIY 掩模/文献评论

  • 模板:参数类型=文献综述的页面数据。
  • 来源和参考文献列表。

指南

文献综述的准备包括几个步骤,可以追溯到以下三个阶段:

  • 第一阶段——准备文献综述
    • 选择主题,定义问题并提出问题。
    • 识别并选择要包含的项目。
    • 选择引用模型
    • 整理包含的物品。
    • 用于分析的数据提取汇总表。
    • 制定概念图
  • 第二阶段——撰写修订稿
    • 介绍。
    • 修订的中心正文。
    • 结论。
    • 引文和参考文献
  • 第三阶段-检查修订
    • 内容审核
    • 以良好的风格撰写评论

查看类别:大多数文献评论,了解如何进行文献评论的指南。

设备和项目

这些页面通常描述技术实现的特定实例,或者通过特定的设计或构造,或者通过在特定设置上实施项目。要了解这两个类别之间的差异,需要注意的是,虽然 Appropedia 上的许多项目涉及设备的构建,但它们并不需要它,因为它们可能使用社会或环境方法和技术。可能的用例是:

  • 不需要构建设备的项目页面。例如,基于社区的项目(清理项目、行动主义)、救灾和救援项目以及其他主要涉及人员、拥有工具和技术作为辅助资源的项目。
  • 涉及设备构建和部署的项目页面。一个例子是研究如何在社区中建造和使用火箭炉。
  • 设备页面包含物料清单、装配说明和复制所需的其他资源。

结构

  • 模板:用于描述设备构建环境的项目数据。
  • 模板:参考其技术文件和其他资源进行复制的设备数据。
  • 模板:带有文档作者描述的页面数据。

基本文档

  • 概述
  • 成品设备照片
  • 材料清单
  • 组装说明
  • 可下载的文件。

指南

  • 区域考虑因素:例如气候、原材料所在地等,以及文化、社会和政治背景。
  • 物料清单:复制设备所需的材料、数量和成本清单。
  • 状态标记:对于项目页面,记下状态非常重要。通常,重新创建或构建适当技术的投资成本很高。在投入时间和资源来采用创新之前,还必须有成功的实施历史。通过遵循Appropedia:Status页面上的说明,可以轻松显示特定适当技术的状态,以帮助用户决定设备的使用,或者在部署之前是否需要进行更多工作。有关详细信息,请参阅Appropedia:状态
  • 组装说明:必须有足够的信息和原理图,让用户相信给定的设计经过了尽职调查,并且设计的设备可以按照规格执行。例如:
  • 有关构建或使用技术或材料的简单操作方法部分
    • 设备的产品名称和一般描述、其预期用途和预期用户。
    • 该设备如何工作?已经被证明了吗?
    • 如果要与其他设备结合使用,请描述如何结合使用。
    • 功能元素的一般描述,例如组件(软件,如果适用)。
    • 包括视觉表示(照片、图画、图表等),清楚地指示组件和解释,以便更好地理解视觉材料。
    • 技术规格,例如尺寸等。
  • 组织最有效的内容是视觉内容。因此,建议使用视觉材料来传达文档。我们建议查看OSHWA 的最佳实践。请在此处查看 Appropedia 上的设备列表:类别:设备

移植的页面

结构

  • 将原始材料标记为移植自
  • 检查版权许可证和权限:在您想要发布照片、文章等之前,您需要验证您可以使用与 Appropedia 上允许的许可证兼容的许可证来共享、重复使用或复制哪些内容。
  • 我们建议编辑内容以适合 Appropedia 上的格式。这将使内容更容易被其他人重复使用。

指南

  • 您可以上传原始图像或文档。然而,扫描仪无法完成 OCR 软件的功能,扫描仪不足以提取相关信息并将其转换为 Word 格式进行编辑。事实上,它所能做的就是创建文档的图像,这只不过是一组白色和黑色或彩色点(光栅图形)。 OCR 技术能够识别图像中存在的字符并将其转换为文字进行编辑。
  • 我们建议使用光学字符识别(OCR) 技术进行移植。这使您可以非常快速地将不同类型的文档(例如数码照片或 PDF 文件)转换为可编辑文本,最重要的是,轻松转换为可编辑格式。

技能页面

技能页面描述并举例说明了如何做某事。它显示了其他人可以通过使用文本或视频来学习的一系列步骤的描述。这是指旨在在不同环境(例如教育和国际发展)中传播知识的所有指南和教程。基于技能的内容在 Appropedia 上可以采取多种形式,例如技术简介(出版者)和书籍(移植文献)。

结构

  • 页面数据
  • 课程数据
  • 带注释的视频

指南

  • 使视频尽可能短。
  • 所有媒体内容均附有基于文本的说明,以确保可移植为其他格式,并为没有良好带宽和小屏幕的人们提供访问性;以及视觉或语言障碍。

课程页面

其中包含组织成学习模块的页面集合

结构

  • 导航数据
  • 课程数据
  • 页面数据
  • 教学大纲

外部链接

Appropedia 欢迎合适的外部链接,甚至是商业链接。合适的链接是那些重点关注与页面直接相关的设计和技术信息,而不是产品或组织促销的链接。

制作文档

Appropedia 拥有一组工具和页面类型,可用于描述各种事物、构建这些事物的方法以及体验。这些旨在适应不同类型的项目,并通过教授其他人理解、适应和执行项目所需的知识和技能来确保其可重复性开放性。

文档对于各种情况和流程都很有用,例如:集思广益和想法映射、设计设备、执行项目或进行研究。 Appropedians 社区通过使用最常见的页面类型或将它们组合来记录现实世界的经验。例如,希望为社区共同创建新型火箭炉的非营利组织可能会通过文献综述来研究以前的解决方案,测试设计并在设备页面上记录其设计文件和组装说明,记录施工的情况使用项目页面,并在技能页面上创建分步说明列表。我们希望 Appropedia 能够服务于所有这些目的。

因此,我们考虑了硬件文档的类型,其中考虑了指令、设计文件[1] [2]以及其他类型的项目(例如国际开发文档中存在的项目)等元素。

这些指南仅适用于主命名空间(除非指南中另有规定)。

也可以看看

参考

  1. ^ Bonvoisin, J. 和 Mies, R. (2018)。使用 Open-o-Meter 测量开源硬件的开放性。普罗塞迪亚 CIRP,78,388–393。https://doi.org/10.1016/j.procir.2018.08.306
  2. OSHWA 认证流程。 (nd)。 2021 年 6 月 16 日检索自https://certification.oshwa.org/process.html
FA 信息 icon.svg向下的角度 icon.svg页面数据
作者加布里埃尔·克劳斯
执照CC-BY-SA-3.0
语言英语(en)
有关的0 个子页面59 个页面链接在这里
别名帮助:内容类型, Appropedia:内容类型, Appropedia:CT , Appropedia:外部链接, Appropedia:内容类型,帮助:页面长度,帮助:部分,帮助:列表,帮助:列表,帮助:页面类型
影响6,314 页面浏览量
已创建加布里埃尔·克劳斯2007 年1 月 29 日
修改的2023 年6 月 29 日作者:Felipe Schenone
Cookies help us deliver our services. By using our services, you agree to our use of cookies.