テクニカルライティングの基本 2023年版テクニカルライティングの基本を学べます。業務マニュアル、報告書、仕様書、技術解説書などのドキュメントを書く機会がある方向け。 サイボウズの2023年度 新入社員向け研修の資料です。 Twitter：https://twitter.com/naoh_nak 2022年版（初版）：https://speakerdeck.com/naohiro_nakata/technicalwriting
Product Requirements Document(=PRD, 製品要求仕様書) - Tbpgr Blog
Increments さんで開催された PM Meetup の記事をみていて気になった Product Requirements Documentについてまとめます。 10/4にIncrements PM Meetup #2を開催しました - Qiita Blog Product Requirements Document とは？ Product Requirements Document(=PRD, 製品要求仕様書)はプロダクトや機能の目的を全て定義したドキュメントです。 これは、プロダクトがどのように作られ、どのようなチームメンバーで作り上げるかも含みます。 また、全てのステークホルダーが目的を正しく理解する役目を果たします。 PRDに求められるもの 何が目的か？ 誰のためにつくるか？ プロダクトや機能の価値は何か？ どのようにユーザーと対話するか？ どんな見た目か？ 完成条件は？ P
GitHub - slatedocs/slate: Beautiful static documentation for your API
Clean, intuitive design — With Slate, the description of your API is on the left side of your documentation, and all the code examples are on the right side. Inspired by Stripe's and PayPal's API docs. Slate is responsive, so it looks great on tablets, phones, and even in print. Everything on a single page — Gone are the days when your users had to search through a million pages to find what they
分かりやすいドキュメントを。APIドキュメントジェネレータまとめ | NTT Communications Developer Portal
APIはシステム用の機能になります。分かりやすいビジュアル化された画面がある訳ではありませんので、使い方のドキュメントが必須です。 今回はAPIドキュメントを生成するためのライブラリを紹介します。 Swagger | The World's Most Popular Framework for APIs. SwaggerはRESTfulなAPIドキュメント生成に対応したツールとなっています。ドキュメントはYAMLを使って記述します。また、Web上でテスト実行できる仕組みが便利です。 RAML - RESTful API modeling language RAMLとはRESTful API Modeling Languageの略で、YAMLフォーマットを使ってRESTfulなAPIドキュメントを作成します。専用のエディタもあり、プレビューで確認しながらドキュメントが書けます。 apiDoc
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
TechCrunch
