hackforla / hackforla/knowledgebase-content
Create a Guide/Template: Documentation Technologies
- 主要言語
- 言語のデータがありません
- スター
- 2
- フォーク
- 1
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
### Overview
We need to create a guide to making a storage for your documentation, therefore we will write a guide discussing different documentation technologies that are available.
### Action Items
The phases in the guide-making process are listed below. Each phase displayed in blue is linked to a wiki page with instructions on how to complete that phase. Open the wiki page in a new tab, copy the instructions for each part into the section labeled 'Tasks' at the bottom of this issue, and complete each task listed.
- [ ] [Gather Examples Solo](https://github.com/hackforla/guides/wiki/How-to-Gather-Examples:-Solo) (open in a new tab)
- [ ] [Gather Examples Collaboratively](https://github.com/hackforla/guides/wiki/Phase-2-%E2%80%90-Gather-Examples-Collaboratively)
- [ ] [Create a Guide Draft](https://github.com/hackforla/guides/wiki/How-to-Draft-a-Guide)
- [ ] If needed, create a template
- [ ] [Have your guide peer reviewed](https://github.com/hackforla/guides/wiki/Peer-Reviews-for-Guides)
- [ ] [Present your guide for leadership review](https://github.com/hackforla/guides/wiki/Submitting-Your-Guide-for-Leadership-Review)
### Resources/Instructions
Google Drive Folder for this Guide’s documents and shortcuts [0145 [DRAFT] Documentation Technologies ](https://drive.google.com/drive/folders/1qRmqiftHcz8Jn8Q417QlfV0SOQBVUFx3)
There are many different free documentation management systems. We use two at Hack for LA
1. GitHub Wiki: To use when your wiki is small
2. MkDocks: As your wiki grows it can become unmanageable. At this point we recommend asking for a documentation repo and installing MK docks.
1. check the project People Depot for examples
- GitHub Wiki: https://github.com/hackforla/peopledepot/wiki
- MkDocks wiki: https://hackforla.github.io/peopledepot/
### Projects to Check
### Tasks
- [ ] This is where you will copy instructions from the wiki page for the step you are currently on.
コントリビューションガイド
調査の方向性
まず、例の収集、ドラフト作成、ピアレビュー、リーダーシップレビューについて説明しているリンク先の wiki の手順を確認し、その後、既存のガイド資料がないか Google Drive フォルダを調べてください。ガイドでは、利用可能なドキュメント技術を比較し、記載されている GitHub Wiki と MkDocks の例を使用して、レビューとリーダーシップの各フェーズを完了する必要があります。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- github
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100