The question and the answer are the most important sections of this doctype. The name and especially the short description properties are often difficult to formulate. The information may be not relevant, since everything is already said in the Q and A. The time invested for finding appropriate information for these properties may not be justified by the additional help given. So if you intend to never list the name and short description, you may enter some arbitrary ids and you are done. But since a description may set the context of the question, a short description may be valuable to readers. Names make is also easier, if your want to reference an FAQ from another document. So you my use a phrases for the Name of an FAQ and a Short Description to set the context of the question in one to three sentences. Example Box |
---|
For instance the question is "Why do I encounter so Ys since we decided X?". The name of the FAQ document my be "Y is not a consequence of X". The short description may read. "Since we decided to use X, which significantly enhanced our product for A, we seem to encounter more problems in respect to Y. But actually this is not true. Analysis has show that Y relates to X." And the answer might start like this: "While it seems that the decision of X led us to a problem with Ys, the root cause of this problem is the new X. The reason ... You find more information about X in ..." |
|