ガイドを記述する

Symbol Developer Documentation guides help other developers to get started on Symbol's technology, giving step-by-step instructions on how to use the tools, integrate with other technologies, and combine the built-in features to architect solutions.

始める前に

If you are looking for inspiration to write the guide, you can browse the symbol-docs repository open issues to find some ideas pending to be written. We also encourage you to join the Discord server and introduce yourself in the #docs-general channel!

To start working on one of the existing issues, state your intention in a comment to avoid duplicated efforts. If there is no issue yet, create a new one (See Making suggestions) and then start working on it.

ガイドを記述する

https://help.github.com/articles/fork-a-repo/ をフォークして`symbol-docs <https://github.com/symbol/symbol-docs>`_ リポジトリをクローンしてください。
```
git clone https://github.com/symbol/symbol-docs.git
```
Python 3.4+ と pip がインストールされていることを確認してください。
```
python --version
```
pipを使用した要求環境のインストール
```
pip install -r requirements.txt
```
ガイドのフォルダ内に新しく rst を作成します。
```
mkdir source/guides/<folder_name>/<title>.rst
```

restructuredText でガイドを作成してコーディングします。テキストのフォーマットについてヘルプが必要な場合は、このチートシートを参照してください。

あなたのコンテンツの整理にこのテンプレートを使用できます:

#####
Title
#####

The objective to achieve after finishing the guide.

********
Use case
********

Explain the necessary concepts before starting to code.

*************
Prerequisites
*************

- A
- B
- C

**********************
Getting into some code
**********************

Present the code and step-by-step explanations.

************
What's next?
************

Is there any extra exercise that readers could try on their own?

コード例を source/resources/examples/<language_or_tool> の下に追加してください。example-code ディレクティブで .rst ファイルの中からコード断片をレンダリングすることもできます。
```
.. example-code::

   .. viewsource:: <relative_url>.ts
       :language: typescript
       :start-after:  /* start block 01*/
       :end-before: /* end block 01 */
```
あなたの変更点をテストしプレビューしてください。
```
make livehtml
```
Push your changes and create a pull-request.

Don't worry if you don't get everything right on the first try. The repository maintainers will proofread and edit the content to follow the documentation style guide.

For more information about the symbol-docs repository continue reading the Documentation guide.