Skip to content
This repository has been archived by the owner on Aug 23, 2022. It is now read-only.

DOCページの作成ガイドを用意する #13

Open
chris-sporelab opened this issue Feb 8, 2018 · 1 comment
Open

DOCページの作成ガイドを用意する #13

chris-sporelab opened this issue Feb 8, 2018 · 1 comment

Comments

@chris-sporelab
Copy link
Collaborator

DOCのページを作成・編集する際に参照できるガイドをWikiなどで用意するのはいかがでしょうか?

以下の内容を含むといいと思います。

  • 各種類のページ向けの構成テンプレート(ページの種類として基本的に「紹介」と「チュートリアル」、「機能の説明」という3つあると思います)
  • enebularの主要的な概念の参考定義
  • その他のガイドライン
@chris-sporelab
Copy link
Collaborator Author

チュートリアルの構成テンプレートとしては以下ような感じがいいと思います(英語)。

  • Introduction
    • Covering what this guide covers
    • Why the user should care / why it’s important
    • What they can expect to know by the end of it
    • Where this component fits into the enebular whole
  • Before you get started
    • Cover any instructions which need to be carried out before the core
      content of the guide can successfully carried out (such as setting
      up datasources (Milkcocoa), AWS Lambda, etc)
  • Main guide content
  • Examples of successful implementation
  • Additional resources
    • Internal links to other guides
    • External links to other reference material
    • Links to support (community groups, enebular support, forums, etc)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant