QNote記事作成の推奨事項
QNote記事作成の推奨事項
最終更新日 2018-08-04
一般的な推奨事項
情報記事の推奨事項
記事を便宜上2つの部分に分けてください。最初の部分では、これから何について述べるのかを簡潔に説明します。1〜2文で十分です。記事のタイトルですべてが言い尽くされており、追加することがなければ、最初の部分は省略してください。2番目の部分では詳細を説明します。情報に何らかの列挙が含まれる場合は、記事エディタのリストを使用してください。記事は自分への作業リストのように書いてください。「してください」「オンにしてください」ではなく、「する」「オンにする」という動詞を使ってください。
記事 - メモの推奨事項
これはあなたが残したい成功または失敗の経験です。ここでは資料がよく構造化されていることが重要です。簡潔に、しかし理解できる程度の分量で書いてください。感情的な色付けは避けてください。 あなたにとってどれほど大変だったか、または簡単だったかは書かないでください。この情報には何の意味もありません。本題から逸れないでください。記事を書く際は次のテンプレートを使用してください：
- 症状
車がどのような症状で来たかを記述してください。お客様が不具合について何と言っていたかを書き留めてください。また、機材を接続する前の車両受け入れ時に気づいた点も記述してください。 - 初期点検
ここではどのような点検が行われたかを記述してください。ここに記述されていないものはすべて未点検とみなされます。この時点では当然と思われる点検が、後になって、または他の人にとっては自明でない場合があります。同時に、DTCのリストを添付したり、エラーがないと書いた場合は、スキャナーを接続したと書く必要はありません。DTCのリスト、ScanDocまたは他のスキャナーから必要なDatastreamパラメータを添付してください。エンジンテスターのオシログラムも。問題が解決しなかった場合は、モジュールから読み取ったすべてのデータストリームを添付してください。問題が解決した場合は、必要なパラメータのみで結構です。識別情報の添付は、後でECUソフトウェアの同一性を判断するのに役立ちます。これを行うことを強くお勧めします。 - 問題の解決または未解決
問題が解決した場合は、原因が何であったか、どのように問題が解決したかを記載してください。問題が解決しなかった場合は、その旨を記してください。参加者の誰かが解決策または解決の方向性を教えてくれるかもしれません。