記事を公開する前に確認していること

こんにちは。
この記事では、私が記事を公開する前に確認していることを書いていきたいと思います。
私はまだ初心者ですが、少しでも参考になれば嬉しいです。

不自然な日本語

記事投稿サイトでは、相手に伝わりやすい記事を書くといいと思います。
そこで、公開する前に不自然な日本語を探します。

例1

以下の文章を直してみましょう。

不自然なテキスト.txt

本日はPythonの最新トレンドについて語ります。

以下は、Pythonのライブラリを紹介する記事の場合の、直し方の例です。

不自然なテキスト_修正済み.txt

この記事では、Pythonでよく使われているライブラリを紹介します。

修正点

1. 本日 を この記事で に変更
   • セミナーではなく記事なので、言い方を変更しました
2. 、 を追加
   • 読みやすくするために、追加しました
3. の最新トレンドについて語ります。 を でよく使われているライブラリを紹介します。 に変更
   • 語っているのではなく、紹介しているので、変更しました

説明不足

説明が足りていない記事の場合、説明を増やしましょう。
プログラムを添付している場合、コメントなどで対応しましょう。

例1

説明が不足しているテキスト.txt

Pythonがおすすめです。

説明が不足しているテキスト_修正済み.txt

Pythonは、公開されているライブラリが多いので、おすすめです。
例えばpygameは、Pythonで動くゲームエンジンのライブラリです。

修正点

1. 理由を追加
2. 例を追加

例2

コメントが少ないPythonプログラム.py

number = 1 + 2
print( number )

コメントが少ないPythonプログラム_修正済み.py

number = 1 + 2 # 1 + 2 を計算し、numberという変数に保存。
print( number ) # numberという変数の内容を読んで、print関数で出力する。

修正点

1. コメントを追加

書ききれなかったこと

以下の内容は書ききれませんでした。

1. 誤字脱字の修正
2. 開発環境を書く (プログラミングの場合)
3. プログラムのバグの修正 (プログラミングの場合)

まとめ

記事を公開する前に内容を確認することで、読みやすい記事にすることができます。