Wordな職場にSwaggerを定着させようとして失敗したけど結局定着した話 - Qiita
はじめに 私の職場では、WebAPIの仕様書をWordで書く習慣があったのですが、2018年頃にSwaggerで書くように切り替わったので、そのように変化した経緯を書きます。 何かの参考になれば幸いです。 ちなみに、こちらの記事と同じ職場です。 Wordな職場にMarkdownを定着させるためにやった４つのこと Swaggerとは？ Swaggerとは、REST APIの仕様を定義するためのフォーマットです。その周辺技術も含めて、Swaggerと呼ばれます。以下の記事が非常に参考になりますので、詳細を知りたい方はご参照ください。 Swaggerの概要をまとめてみた。 Swagger 導入失敗 2016年頃のある日、上司から「世の中にはSwaggerというものがあるらしい。調べてもらえる？」と指示されました。 調べてみたところ、Swaggerがあれば、WebAPIのドキュメントサイトも作れる
Wordな職場にMarkdownを定着させるためにやった４つのこと - Qiita
はじめに ドキュメントって皆さんどうしていますか？ Qiitaで記事を書いている方なら、Markdownを普段から使う人も多いと思います。 私の職場では、「Wordでドキュメントを書く」という習慣がありました。 最近、「Markdownで書く」というのを定着させることができましたので、その過程で何をやったのかを共有したいと思います。 2018/11/02 追記 本記事に、Microsoft Wordを批判する意図はございません。 WordよりもMarkdownが優れているという主張をするつもりもございません。 それと、後出しで恐縮ですが、本記事に登場する職場とは、ソフトウェアエンジニアがメインの部署です。 ドキュメントというのも、技術系資料です。 その前提でお読みください。 誤解があるといけないので追記いたしました。 （追記終わり） やったこと１：議事録をMarkdownで取った 私の職場
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
