テクニカルライティングの基本
テクニカルライティングの基本を学べます。サイボウズの新入社員向け研修資料です。業務マニュアル、報告書、仕様書、技術解説書などのドキュメントを書く機会がある方向け。 Twitter‥https://twitter.com/naoh_nak 2023年度のアップデート版もあります‥https://speakerdeck.com/naohiro_nakata/technicalwriting2023
開発ドキュメントの書き方！9つのコツ【エンジニア】
エラーメッセージ | コンテンツ | SmartHR Design System
アプリケーション内に表示するエラーメッセージの作成に関するガイドラインです。 エラーメッセージのライティングは、基本的にライティングスタイル、用字用語に準拠します。 そのほか、エラーメッセージ特有の気をつけるべきポイントを記載しています。 適用範囲アプリケーションを操作してエラーが発生したときに表示するメッセージすべてです。 ここでは、以下の場合について説明します。 バックグラウンド処理画面FlashMessageエラーメッセージの基本的な考え方エラーメッセージを表示する目的は、ユーザーがメッセージを見て問題を解決でき、次の操作に進める状態にすることです。 この状態を実現できないエラーメッセージだった場合、ユーザーの戸惑いや不安につながります。 ユーザーが問題を解決できる対処方法を明示した内容にすることを考えます。 エラーメッセージの基本的な要素どのエラーメッセージであっても、含める情報の
「カップ麺の出来上がりを待っていたら3日前一緒に居た同僚がコロナ陽性になったと連絡が来た」から始まる文才の塊みたいな137文字
Writing better release notes
31st January 2022 Release notes are an important part of the open source process. I’ve been thinking about these a lot recently, and I’ve assembled some thoughts on how to do a better job with them. Write release notes. Seriously—if you want people to take advantage of the work you have been doing to improve your projects, you need to tell them about it! Include the date. The date matters a lot, b
伝えたい人に届ける技術記事の書き方 - Qiita
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
