はじめに
広報:「広報や採用で使いたいから技術を発信して」
エンジニア:「何を・どうやって書いたらいいか分からん」
広報:「登壇しろ、それかせめてQiita
書け」
エンジニア:「そんな時間ない、開発で忙しい」
このような状況の会社少なからずあるのではと思います。
なぜ書いたか
広報部門が困っている。エンジニアも書きたいけど書けない。
そんな会社や人のために、エンジニアが省エネで書けるフォーマットを用意しました。
本文
以下の4ステップで記事が完成します
- 分かりやすいタイトルを決める
- キーワードを追加する
- 以下のフォーマットをコピペ&修正する
- 投稿する
# はじめに
<問題や課題、執筆に至った経緯など>
こんにちは、インフラエンジニアです。
普段はKubernetes(GKE)をよく使っています。
# 何を書いたか(本題が短い場合は不要)
<本題の要約>
# なぜ書いたか
<状況や目的、対象読者>
K8sをCLIで操作する際にKubectlというコマンドがあるのですが
タイプするのが面倒くさい!長い!
なので、便利なエイリアスを設定したので記事にしました。
# 本題
<本題が大きい場合はTopicに分割>
Macの場合
$ vim ~/.bash_profile
以下の二行を追加して保存
alias k='kubectl'
alias kg='kubectl get'
$ source ~/.bash_profile
k で kubectl を実行できるようになります。
簡単ですね。
### Topic1
### Topic2
# 参考文献(なければ不要)
<参考にした文献や引用した資料がある場合は記載>
[Qiitaで簡単に記事を書くためのフォーマット](https:)
# 最後に
<もしあれば一言とお礼>
最後まで読んでいただきありがとうございます!
ちなみにこのフォーマットで作った記事がこちらです
*以下の小技も少し使ってます
小技
コードを[```]で囲うとそれっぽくなります
(空行)
```ruby:qiita.rb
puts 'The best way to log and share programmers knowledge.'
(空行)
↑が↓になります。
```ruby:qiita.rb
puts 'The best way to log and share programmers knowledge.'
```言語(なくてもOK):ファイル名(なくてもOK)
コード or コマンド
# 参考文献
[Qiitaで良い記事を書く技術](https://qiita.com/t12u/items/8c28484100dfd3a6351b#1-1-%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB%E3%82%BF%E3%82%A4%E3%83%88%E3%83%AB%E3%82%92%E6%B1%BA%E3%82%81%E3%82%8B)
# 最後に
この記事をストックして、記事を書くときに本文の内容をコピペ&修正すると便利です。
最後まで読んでいただきありがとうございました。