2024-12-08

markdownについて

SE道

何か技術っぽい記事を書くときに便利なmarkdownを習得したいので、自分で利用しがてらまとめてみることにする。

見出し
太字
斜字
取り消し線
改行
リスト（箇条書き）
数字付きリスト
チェックボックス
コードブロック

見出し

ポイント

見出しの文字の前に#(シャープ) を付与する
#の後には半角スペースを入れる
#の数が少ないほど大きい見出しになる
#は最大で６つまで

コード

# 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6
####### 見出し7

プレビュー

※実際に書くと目次がバグるので画像を貼っています

太字

ポイント

** または __で文字を挟む

コード

アスタリスクふたつで挟むと**太字**になるよ
アンダースコアふたつでも__同じ__だよ

プレビュー

アスタリスクふたつで挟んだものが太字になるよ
アンダースコアふたつでも同じだよ

斜字

ポイント

* または _ で文字を挟む
日本語は斜字にならない？

コード

abcdefg　*abcdefg*　_abcdefg_
1234567　*1234567*　_1234567_
愛うえお　*愛うえお*　_愛うえお_

プレビュー

abcdefg　abcdefg　abcdefg
1234567　1234567　1234567
愛うえお　愛うえお　愛うえお

取り消し線

ポイント

~~で文字を挟む

コード

チルダふたつで挟むと~~取り消し線~~が入ります

プレビュー

チルダふたつで挟むと~~取り消し線~~が入ります

改行

ポイント

<br>で改行できる
半角スペースの2連続でも改行できる（※行末のみ有効）

コード

1行目<br>あああ<br>
2行目(コード上は改行してるけど実際は改行されない)
3行目
4行目(この後ろに半角スペースx2あり)  
5行目

プレビュー

1行目
あああ
2行目(コード上では改行してるけど実際は改行されない) 3行目 4行目(この後ろに半角スペースx2あり)
5行目

リスト（箇条書き）

ポイント

先頭に「-」「*」「+」のいずれかを付与するとリストになる
後ろに半角スペースを入れる必要あり
先頭に半角スペースを付与することでインデントを増やせる

コード

- 箇条書き１
- 箇条書き２
  - 先頭に半角スペースをふたつ入れると深くなる
    - さらにふたつ入れるとさらに深くなる

プレビュー

箇条書き１
箇条書き２
- 先頭に半角スペースをふたつ入れると深くなる
  - さらにふたつ入れるとさらに深くなる

数字付きリスト

ポイント

先頭に数字＋ピリオドを付与することで数字付きリストになる
ピリオドの後には半角スペースが必要
数字を付けるのは最初だけでもOK

コード

1. ひとつめ
- ふたつめ
  1. ふたつめの一つ目
  - ふたつめの二つ目
- みっつめ
- よっつめ

プレビュー

ひとつめ
ふたつめ
1. ふたつめの一つ目
2. ふたつめの二つ目
みっつめ
よっつめ

チェックボックス

※はてなでは表示できないようです

ポイント

リストの後ろに[ ]を付与すると未チェックのボックスになる
[x]を付与するとチェック済のボックスになる
前後に半角スペースが必要

コード

- [x] タスク１
- [ ] タスク２

プレビュー

[x] タスク１
[ ] タスク２

コードブロック

ポイント

バッククォート（ [Shift]+[＠のキー] で入力できる記号）で囲む
コードブロック内でバッククォートをしたいときは、囲んでるバッククォートの数を増やす
バッククォート３連で行を挟むことで、複数行に渡ってブロック化できる
プログラミング言語を記載するとシンタックスハイライトさせることも可能

コード

`hello world`ってなに。`` `Hi` world``ではあかんの。

``` python
def hi_world():
    print("Hi world")
```

プレビュー

hello worldってなに。`Hi` worldではあかんの。

def hi_world():
    print("Hi world")

2024-09-22

文書を書くときに意識すること

SE道

私の今までの経験から得られたものをまとめておきたかったので書きます。

システムエンジニア目線の内容ですが、一般的にも通用する部分もあるかもです。

また、ここでの「文書」ってのは「正式な書類に記載する文書」を指しているつもりです。（設計書とか、、ね）

なにが言いたいかっていうと、話し言葉とか、ビジネスチャットとかメールとかはこんなこと意識しなくてもいいよねってことですわ。

それでは本題へ、、、

■だれが読む文書か？を把握して言葉を選ぶ

だれにとっても読みやすい文書であればそれに越したことはないが、一番重要なのは、その文書のターゲットにとって理解し易い文書であること。
読み手が理解しやすい単語を選ぶようにすると良い。（というか選ばないといけない）

■句点の入れどころを意識しよう

（執筆中）

■一つの文はできるだけ短く

句点(。)にたどり着くまでの読点(、)の数は３個くらいを上限にしてみたら良い。（あくまでも目安）
一つの単語が長くて文書が長くなることは問題ない。

■その修飾語ってほんとに必要？

副詞とか形容詞は無しでも問題ないことが多い気がする。
どうしても修飾する必要がある場合を除いて基本は省いてもよいかもね。

■主語は省略しても大丈夫か？

日本語の文では主語がないことが多い。
執筆側からしたら省略しても問題ない主語でも、読み手が「この文書よく理解できない」ってなることもあるので、「主語を省略しても読み手が理解できるか？」をセルフチェックしてみるといいですねえ。

■箇条書きは積極的に

たとえば、設計書を書くとき、特定の処理を実行するときの条件を記載することはよくあります。
そんなときに「AとBとCを満たす場合・・・」と書くよりも、「以下の３つをすべて満たすとき・・・」と書いて箇条書きを活用するほうが読みやすい。（A,B,C のそれぞれが長めの文章で表現されるものであれば、その効果は絶大）

■接続詞は正しく使われているか

間違った接続詞は文書を読み難くする要因になります。
よくあるのは、「～だが」「～ですが」という接続詞について、本来は逆説で使用する接続詞ですが順接で使用されることが多いですね。

後でなにか思い出したら追記していこうとおもいます！

あとは参考になった記事をご紹介しまっす

note.com

2024-09-18

【未来の私へ】SEとして生きる上で意識してほしいこと

SE道

■知ったかぶりはしない

わからないことは理解していないこと伝えて、理解する必要があるなら全力で理解しようとしましょう！

■恥ずかしいとか思わない

自分がその発言をすることによって自分が周りからどう思われるか、を気にしないで動いてくれ。
仕事ができないやつに見られたくないプライドが働きがちで、思ったことを言わないとか聞きたいことを聞かない状況に陥っています。
発言にはある程度は気にするべきだが（例えば、人を傷付ける発言は避けるとか）、考えすぎて発言を避けるのはやめよう。

■あまり真面目になりすぎない

責任を感じ過ぎて気を病むことがあります。
気を病むとパフォーマンスが悪くなるので、責任を感じすぎないようにしましょう。
言ってしまえば、ほとんどの仕事はチームでやっているので個人ではなくチームの責任です。
そのため、個人が責任を感じ過ぎる必要はありません。（これは責任放棄ではなく正論）
もちろん、ミスに対して反省はしましょう。
強いメンタルを持つというよりは、少しは「たかが仕事やし、どうでもいいか」という気持ちを持って仕事と向き合いましょう。
また、責任を背負う必要がないような立ち回りも意識しましょう。（自分で0から100までやるではなく、周りを巻き込むとか）

■謙虚で毅然とした人であれ

人を下にみて接し方を変えたりしないこと。
また、偉い人に対しても堂々としていること。
それでいて謙虚な気持ちは忘れないこと。

■アウトプットは早くしましょう

成果物の作成の目標としては、納期の50％の期間で80％の進捗の状態を目指しましょう。
初めての分野で質の高い成果物が作れる自信がないなら、スピードだけは最速を目指しましょう。
また、自分ボールのタスクはできるだけ早くに手放すことを意識しましょう。