こんにちは。壮（@sew_sou19）と申します。 メガベンチャー企業でエンジニアとして働いています。 エンジニアにジョブチェンジした当初は、ドキュメントの書き方なんてこれっぽっちも分かりませんでした。読みやすいドキュメントを書くことが本当に苦痛だったのですが、考えて、試行錯誤し続けた結果、以下のような評価を得るに至りました。 リーダーから「君は情報の整理が上手でドキュメントが本当に読みやすい。チーム全体の能力向上に繋げたいからドキュメント書く際のポイント共有してほしい」と言われたので、意識していることを言語化しつつテクニカルライティングの本でインプットしてるけど、学びが多い。ついでにnoteにもまとめてる — 壮 (@sew_sou19) November 28, 2022 そこでこのnoteでは、僕がドキュメントを作成するときに、特に意識して実践している7つのことを書きます。（本当は2
Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? さまざまなニュースアプリ、ブログ、SNSと近年テキストの情報はますます増えています。日々たくさんの情報が配信されるため、Twitterやまとめサイトを見ていたら数時間たっていた・・・なんてこともよくあると思います。世はまさに大自然言語時代。 *from [THE HISTORICAL GROWTH OF DATA: WHY WE NEED A FASTER TRANSFER SOLUTION FOR LARGE DATA SETS](https://www.signiant.com/articles/file-transfer/the-
クラス仕様をJavadocでドキュメント化すると、ときおりシーケンス図を載せたくなる場合があります。 DoxygenではMscgen: A Message Sequence Chart Rendererというツールがあってコメント中にテキストでシーケンス図の定義を書くと、ドキュメント生成時に画像ファイルを生成しドキュメント中に画像リンクを追加してくれる機能がありました。 Javadocの場合は、Quick Sequence Diagram Editor - Summaryというツールがあり、Javadocコメント中にテキストでシーケンス図の定義を書くと、HTMLドキュメント生成時に画像ファイルを生成し、HTML中に画像リンクを追加してくれる機能があります。 Javadocのタグレットとして動作するので、Javadocコマンドのオプションで指定します。 http://sdedit.sourc
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
