Skip to content

Commit

Permalink
fix
Browse files Browse the repository at this point in the history
  • Loading branch information
sadnessOjisan committed Sep 19, 2023
1 parent 4eedf81 commit 8a524da
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions src/contents/202309109-for-doc-job/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,9 @@ isProtect: true

## どうしてドキュメントを書くような仕事をしたいのか

いまこういったブログを運営している理由でもあるのだが、自分が困ったことに対する怒りがあるからだ。自分はプログラミングが好きであれど苦手だ。そんな人に向けた学習のラダーというのは全然整備されていないなと常々思う。どの分野でも言われているとは思うが、中級者への道が整備されていないというやつだ。なので俺が整備するぞの気持ちで、自分ができなかったことに挑戦したら、それを理解するまでの過程を包み隠さずブログにしている。なので、ライブラリのコードリーディングやら低レイヤーからの自作や自分が困ったことのワークアラウンドやソリューションがブログの題材になりやすい
いまこういったブログを運営している理由でもあるのだが、自分が困ったことに対する怒りがあるからだ。自分はプログラミングが好きであれど苦手だ。大体の既存のドキュメントは「それは書かれなくても知ってる」「なんもわからん」という感想だ。「なんもわからん」なドキュメントに出会うたびに、学習のラダーというのは全然整備されていないなと常々思う。どの分野でも言われているとは思うが、中級者への道が整備されていないというやつだ。なので「俺は中級者向けへの道を整備するぞ」の気持ちで、自分ができなかったことに挑戦したらそれを理解するまでの過程を包み隠さずブログにしている。自分のブログの題材がライブラリのコードリーディングやら、低レイヤーからの自作やら、自分が困ったことのワークアラウンドやら、ソリューションになるのはそういった理由がある

実はそういった、中級者へのラダー的な視点を持ったドキュメントを書く仕事は存在するのかが最近気になっている。エンジニア向けのサービスを提供している会社は自社の製品を広く使ってもらう必要があって、そのために使うためのハードルを下げるというのはその製品のファンを増やすという点でとても有効だと思う。「なんか便利そうだけど自分が解決したい問題が本当に解決できるかわからなくて採用できない」というケースはそれなりにあると思っている。これを「もし自分がドキュメントだけでなくExampleをたくさん整備することで解決できたりしないかな」と思っている。「そのギャップを補うための公式チュートリアルだと思うのですよ。「わかる」は「動かす」の後からついてくる。」というツイートを見て、そういったチュートリアルを作りたいと思った。

https://twitter.com/t_wada/status/1701412333292249235

世のドキュメントはAPIリファレンス的なものが多いと思っていて、あまり分かっていない人に向けた「わかる」には寄り添ってくれていないなと思っている(すくなくとも俺はわかっていないので、俺には寄り添ってくれていない!)。なので自分は動かしてみて、実装を読んで、最小構成を作って、自分の理解を文章にして発信をするようにしているのだが、これを仕事にできないかなぁと思っている。幸いにも自分は手を動かすのはかなり好きだ。ただドキュメントを書くだけではなく事例の整備を積極的にできるし、したい。なので事例の整備なども含めてドキュメントを整備するような仕事はないだろうかと気になっている。
そういった、中級者へのラダー的な視点を持ったドキュメントを書く仕事は存在するのかが最近気になっている。エンジニア向けのサービスを提供している会社は自社の製品を広く使ってもらう必要があって、そのために使うためのハードルを下げるというのはその製品のファンを増やすという点でとても有効だ。「なんか便利そうだけど自分が解決したい問題が本当に解決できるかわからなくて採用できない」というケースはそれなりにあるだろう。以前 t_wada さんの「[そのギャップを補うための公式チュートリアルだと思うのですよ。「わかる」は「動かす](https://twitter.com/t_wada/status/1701412333292249235)」の後からついてくる。」というツイートを見て、ドキュメントだけでなくExampleのようなものを充実させる仕事で解決できるかもしれないと思ったのと、自分は手が動くし動かすのも好きだからそのような仕事をする機会がないだろうかと考えるようになった。

## ドキュメントを書くためのキャリアパスは?

Expand Down

0 comments on commit 8a524da

Please sign in to comment.