ブログ添削 - HackMD

ブログ添削 === ## 全体の構成 - いきなりアプリの用途を説明しないで欲しい - 記事を読む側からすると以下の事柄が最初に書いてあってほしいですね 1. どういうアプリなのか - 記事冒頭でどういうアプリか1行説明が書かれているので, ここでは複数行を用いてそれよりも詳細にアプリの説明をする 3. 何故作ったのか - いわゆる動機, モチベーション - 動機は厳密に「現在抱えている問題」=>「それを解決する手段」の順で説明して下さい - 問題の例: TwitterのBotなどでアニメの放送時刻を知ることができるが, 通知のタイミングをユーザ好みに調整できない - 解決手段の例: ユーザが通知のタイミングを好みに調整できるアプリを作った - 例では問題を1つしか挙げていないけど, 2つ以上あるなら当然それも書くべき - というか下書きでは「1. アプリの用途」が「何故作ったのか」に該当する項なのに「用途」という見出しを付けているのはおかしいですよね - 良い例: https://www.mizdra.net/entry/2017/12/01/000009 の「Emtimerの紹介」の項 - 「どういうアプリなのか」「何故作ったのか」が記事の中で一番重要なので, 一番気合を入れて書きましょう - 気合を入れて書く != 大げさに誇張して書く - 気合を入れて書く ~= アプリを使わない人が読んでも問題とそれに対する解決手段が納得できるように書く - ところで文章書く時は必ずアウトラインを書くようにと言っていましたが, アウトライン書きましたか??? ## タイトル - `(Androidアプリ)` - タイトルは完結にすべきなので要らない ## 目次 - 大した文章量ないので要らない ## このアプリの対象 - これいる? - 「どういうアプリなのか」「何故作ったのか」がちゃんと書けていれば, どういうユーザを対象にしているか自明になるので要らないはず ## ログイン画面 - `初めてAnimeCheckerアプリを起動した時の画面です。` - 主語は？？？ - 多分「下図」が主語ですよね - 改善案: `下図は初めてAnimeCheckerアプリを起動した時の画面です。` - より良い改善案: `初めてAnimeCheckerアプリを起動すると, 以下の画面が表示されます` - さらに良い改善案: `初めてAnimeCheckerアプリを起動すると, ログイン画面が表示されます` - 画像を使わず, 文章だけで完結しているほうが良い - 画像を使って説明しようとすると, 本来文章で説明すべきことが抜けてしまいがち - 「ユーザに画像から読み取ってもらえば良い」は説明責任の放棄に等しい - 画像はあくまで文章の補足のために使うべき - 良い例: https://www.mizdra.net/entry/2017/12/01/000009 - 基本的に画像は動画は見なくても, 文章だけ読めば分かるようになってるはず - 画像を使って説明しようとするから記事が画像で溢れるんですよ… - というかいきなり使い方の説明を始めないでほしい - 見出しは「使い方」にするべきでは??? # 訂正案(博紀) ## アプリの紹介 - いきなりアプリの用途を説明しないで欲しい - 記事を読む側からすると以下の事柄が最初に書いてあってほしいですね 1. どういうアプリなのか 2. 何故作ったのか > アニメの放送を毎週通知するアプリ「AnimeChecker」を作りました。例：通知は以下のように表示されます。アウトラインで書きます。幾つか候補を書きます。 - どういうアプリなのか - アニメの放送より少し前に通知し、アニメの放送を事前に伝える - アニメの放送を事前に伝えるアプリです。好きな時間に通知ができる柔軟なアプリです。 - 今期のアニメの放送前に通知するアプリです。 - アニメの放送時間をリマインドしてくれるアプリです。 - 今期のアニメの放送を指定時間前に複数回、お知らせするアプリです。 - 何故作ったのか - アニメを見逃さない - 問題(他のアプリが全てに当てはまるわけではない) - 通知の時間が固定されていて指定できない。 - 通知は1度のみ - 「放送前に通知」は1回しか通知しない - 時間を設定するための作業が多い - スピナー - - 解決 - 通知時間を選べる見逃し防止 - 放送時間前に通知します。 - ただし、選択肢から選ぶ() - 複数回に分けて、通知する - 1つだけではなく、複数の通知を作成することができます - 少ないタップ操作 - 放送時間の指定には、時計を使用 - 曜日はChipで一つしか選択できない - 通知の作成には、Chipを使用 - - このアプリの問題点 - 時間は手動入力なので、手間がかかる - Annictの新規アカウントを作らなければいけない - しょぼんカレンダーをスクレイピングすればよかった？ - ただし、開発時間はそこまでとれない - 通知作成機能はAnnictとは関係ない - Annictは今期のアニメを取得するためだけに使用 - 通知機能とはまっっっっったく関係ない - Annict依存なのでAPIが死ぬと、通知が設定できない。 - このアプリは毎回アニメをAPI経由でロードしている - DBに保存すれば、いいのでは - しょぼんカレンダーも使う手もある - Annictはしょぼんカレンダー依存？ - スマホの再起動すると、通知が消える - 解決策が書いてあった記事の通りコードを書いたが駄目だった - 通知の再設定を行うと、通知が消える - 通知を消して、通知を作成しているため？ - トランザクションで安全に操作か - UPDATEを使う - コスト的に「消して作成する」方が実装するのは楽だった - ただし、結果として、不具合を引き起こした - 一度不具合が起こると、アプリの設定からデータの削除を行わなければならない - 電池くいそう - しょうがない - ログアウトしても通知が飛ぶ - 今期のアニメのPaging処理に不具合あり - 下の方にあるアニメをタップしても、違うアニメが選択される - 既に通知を作成したアニメは今期のアニメに表示しない処理の為か？？？ - それか、リストビューの問題(PagingList) - Position問題の可能性も？？ ## タイトルタイトルは簡潔に - アニメの通知アプリの制作詳細 ## 作品を登録する - 「通知一覧画面」にて、右下のアイコンタップすると、今期のアニメが表示されます。アニメを選ぶと、通知の設定ができます。最後に通知を作成して完了です。 ## 通知時間を直感的な操作で簡単に設定 Chipをタップするだけです。スピナーより少ないタップ数で通知を設定することができます。また、複数通知を設定できます。 ## 設定したアニメ作品が一覧で見れるホーム画面に、通知を設定したアニメが並びます。 --------- ## 通知一覧画面これは、画像を使わなくてもいいかな - 2種類の画面パターンが存在する為説明 - この画面では、作成したアニメの通知が並びます。しかし、起動した直後は「通知がありません」表示されます。 - 現状維持 - これから、通知を作成していきます。右下の「通知追加アイコン」をタップすると、「アニメ選択画面」に移ります。 ## アニメ選択画面 - 通知するアニメを、今期のアニメから選びます。好きなアニメを選択すると「通知編集画面」に移ります。 - アニメ、アニメ言いすぎ問題 - 通知するアニメを、今期のアニメから選びます。選択すると「通知編集画面」に移ります。 ## 通知編集画面 - 通知設定画面で、通知設定を作成することができます。 - これはおｋ？ - 「放送時間」「曜日」「通知時間」を指定し通知を作成できます。 ## 通知を作編集する機能作成した通知をタップすると再編集か通知を削除することができます。 ## AnimeCheckerにログインする。 oauth認証でAnimeCheckerに権利を与えると、認証コードが発行されるので張り付けて下さい。 - Annictアカウント作成の詳細はいらないのではないか説 - あくまで、アプリの紹介をする記事にする。 - というか、別の所に書いてもいいのでは、記事の一番下か、別記事にすべき - 文字で書くべきなのでは... - oauth認証を使用していますでいいかな？？ - oauth認証でAnimeCheckerに権利を与えると、認証コードが発行されるので張り付けて下さい