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 6c59ab9 commit e774cab
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions src/contents/202309109-for-doc-job/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ path: /for-doc-job
created: "2023-09-19"
title: ドキュメントを書く仕事を探している
visual: "./visual.png"
tags: [gatsby, jamstack]
tags: [雑記]
userId: sadnessOjisan
isFavorite: false
isProtect: false
isProtect: true
---

飲み会で「お前、次の転職どうするよ?」的な話をするときはいつも
Expand All @@ -21,13 +21,9 @@ isProtect: false

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

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

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

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

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

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

Expand All @@ -44,11 +40,11 @@ https://twitter.com/t_wada/status/1701412333292249235

といった感じであった。

DevRelがドキュメントやExampleの整備をしている事例で一番印象に残っているのは Fastly だ。例えば [DevRel チームの一番(?)偉い人が書いた記事](https://www.fastly.com/jp/blog/andrew-betts) (Andrew Betts を持ち出すのは極端な例という自覚はあるが…)とかを読んでいると、いかに Fastly を使いこなすかということがユーザー目線で書かれている。例えば [OpenTelemetry 第2回 : VCL で OpenTelemetry](https://www.fastly.com/jp/blog/opentelemetry-part-2-using-opentelemetry-in-vcl) を使用する なんかは自分でも VCL での計装やりたいと思わせてくれたり、W3C の Tracing Context の Spec を読むきっかけになった記事でもあり、自分の心を動かしてくれた記事だ。( そもそも VCL じゃなくて C@E 使えと言われそうだが、どうしても VCL を使い続けないといけない会社の元に生まれてしまったり、computing より deliver の方が遥かに安上がりという理由で VCL を使い続ける人だっているのだ。わざわざVCLでやる方法を記事にしてくれているのは現場の開発者への寄り添い力が高くて最高!)そしてこの記事を読み終わってから、「俺も!こういう記事を!仕事として書きたい!!」と思った。
DevRelがドキュメントやExampleの整備をしている事例で一番印象に残っているのは Fastly だ。例えば [DevRel チームの一番(?)偉い人が書いた記事](https://www.fastly.com/jp/blog/andrew-betts) (Andrew Betts を持ち出すのは極端な例という自覚はあるが…)とかを読んでいると、いかに Fastly を使いこなすかということがユーザー目線で書かれている。例えば [OpenTelemetry 第2回 : VCL で OpenTelemetry を使用する](https://www.fastly.com/jp/blog/opentelemetry-part-2-using-opentelemetry-in-vcl) なんかは自分でも VCL での計装やりたいと思わせてくれたり、W3C の Tracing Context の Spec を読むきっかけになった記事でもあり、自分の心を動かしてくれた記事だ。( そもそも VCL じゃなくて C@E 使えと言われそうだが、どうしても VCL を使い続けないといけない会社の元に生まれてしまったり、computing より deliver の方が遥かに安上がりという理由で VCL を使い続ける人だっているのだ。わざわざVCLでやる方法を記事にしてくれているのは現場の開発者への寄り添い力が高くて最高!)この記事を読み終わってから、「俺も!こういう記事を!仕事として書きたい!!」と思った。

自分は [Varnish の勉強は Fastly のドキュメントサイト](https://docs.fastly.com/ja/guides/guide-to-vcl)を見ていたので、Fastly 製品関係なくたくさん勉強できた。そういった自社製品に直結しないことまでケアした資料を出してくれるのはめちゃくちゃかっこいいと思うし、自分はFastlyのファンになった。ドキュメント以外にも実践的なユースケースを[全部 Example で用意してくれている](https://developer.fastly.com/solutions/examples/)のは仕事する上でもとても役に立った。こうやって自分が魅了されてみて、今度は自分がそういったドキュメントやExampleを書く仕事をしたいと思った。
自分は [Varnish の勉強は Fastly のドキュメントサイト](https://docs.fastly.com/ja/guides/guide-to-vcl)を見ていたので、Fastly 製品関係なくたくさん勉強できた。自社製品に直結しないことまでケアした資料を出してくれるのはめちゃくちゃかっこいいと思うし、自分はFastlyのファンになった。ドキュメント以外にも実践的なユースケースを[全部 Example で用意してくれている](https://developer.fastly.com/solutions/examples/)のは仕事する上でもとても役に立った。こうやって自分が魅了されてみて、今度は自分がそういったドキュメントやExampleを書く仕事をしたいと思った。

自分は世のクラウドベンダーや開発者向けSaaSなどのドキュメントやExampleに対してして「うわああああん😢読んでも分からないよ〜僕にも分かるように書いてよ〜〜〜😭」という感じなのだが、ただもしこれが「本当はもっと充実させたいのだけど、人手が足りなくて・・・」といったことに起因しているのであれば、是非とも雇われたい。書かせてください。
自分は世のクラウドベンダーや開発者向けSaaSなどのドキュメントやExampleに対してして「うわああああん😢読んでも分からないよ〜僕にも分かるように書いてよ〜〜〜😭」という感じなのだが、もしこれが「本当はもっと充実させたいのだけど、人手が足りなくて・・・」といったことに起因しているのであれば、是非とも雇われたい。書かせてください。

### カスタマーエンジニア / ソリューションアーキテクト

Expand All @@ -62,7 +58,7 @@ DevRelがドキュメントやExampleの整備をしている事例で一番印

### 記者

盲点だった。身近な人に聞いて見たり、購読してみて思ったのは、新聞や雑誌の記者職という手もあった。自分で調べて文字にして発信するというところだけを見れば当てはまる。自分でコードを書いてそれを発信するということはできないのだろうが、記者の人と話して見た限りでは開発の現場で通用、もしくはそれ以上の専門性が必要だとも感じ、ずっと勉強をしなければいけないという点でも楽しそうだと思った。もし良い記事を書く自体を目的にできるのなら、自分の性格や志向にも合いそうと思った。
盲点だった。身近な人に聞いて見たり、購読してみて思ったのは、新聞や雑誌の記者職という手もあるのかということだった。自分で調べて文字にして発信するというところだけを見れば当てはまる。自分でコードを書いてそれを発信するということはできないのだろうが、記者の人と話して見た限りでは開発の現場で通用、もしくはそれ以上の専門性が必要だとも感じ、ずっと勉強をしなければいけないという点でも楽しそうだと思った。もし良い記事を書く自体を目的にできるのなら、自分の性格や志向にも合いそうと思った。

## ゆるぼ

Expand Down

0 comments on commit e774cab

Please sign in to comment.