Skip to content

Commit

Permalink
執筆の方法について追記
Browse files Browse the repository at this point in the history
  • Loading branch information
noraworld authored Jan 15, 2024
1 parent 32a30a2 commit 913c059
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,26 @@ Qiita に直接投稿していた過去記事に関しては、**編集履歴含

それはさておき、過去記事の移行が完了した時点で 399 commits だった。そしてこの項を README に追加する変更で合計 400 commits だ。ここからは Git で管理するのをメインとし、Qiita へは API 経由で投稿する。

## 執筆の方法
久しぶりに技術記事を執筆するときに忘れてしまうのでメモしておく。

まず始めに Zenn で slug 名が重複していないことを確認する。ブラウザで `https://zenn.dev/link/articles/<SLUG_NAME>` にアクセスして 404 Not Found が返ってくることを確認する。記事が見つかった場合は slug 名が重複しているので別の名前を検討する。

以下のコマンドを実行しテンプレート付きのファイルを新規作成する。

```shell
npx zenn new:article --slug <SLUG_NAME>
```

## 執筆する際のアドバイス
* 最初に見出しだけを書く
* 上から順番に文章を書こうとするとダラダラと長く書きがちになるので
* 見出しの次に実行するコマンドやコードだけを書く
* 画像や表が必要な場合は文章を書く前に追加する
* 最後に必要な文章を付け足す
* 文章はなるべく短く簡潔に書き、補足情報は重要な文章と混ざらないようにする
* 可読性向上のため

## Zenn における記事執筆時のルールについて
### HTML を使用しない
Qiita と違って、Zenn では HTML を解釈しないので、以下のような理由で HTML を使用することはできない。
Expand Down

0 comments on commit 913c059

Please sign in to comment.