You are not logged in. Your edit will be placed in a queue until it is peer reviewed.
We welcome edits that make the post easier to understand and more valuable for readers. Because community members review edits, please try to make the post substantially better than how you found it, for example, by fixing grammar or adding additional resources and hyperlinks.
Required fields*
- 2Are there dedicated QA resources assigned to the project?hardmath– hardmath2013-04-22 17:41:24 +00:00Commented Apr 22, 2013 at 17:41
- 1@hardmath Yes there is. Our users enter QA period periodically. But the QA documentation and test scripts are written by the dev team, and is not included under the umbrella of this question.ayla– ayla2013-04-22 17:59:19 +00:00Commented Apr 22, 2013 at 17:59
- 2would it be possible to generate the requested documents via some sort of automated process? Yeah, its a workaround but it might be a useful option to consider.Winston Ewert– Winston Ewert2013-04-22 18:21:11 +00:00Commented Apr 22, 2013 at 18:21
- 2I can't imagine why anybody would want screenshots of code, or in-code comments describing the UI. Neither seem particularly useful.Eric King– Eric King2013-04-23 18:08:20 +00:00Commented Apr 23, 2013 at 18:08
- 2@jordan.peoples I agree with you that before/after screenshots of code is silly. Huge waste. That's what source control diffs are for. But there can definitely be a place for external documentation with UI screenshots, too. Even for developer documentation. Somehow I get the feeling your boss probably won't want to get rid of external documentation altogether (and he probably shouldn't). But you could make a convincing argument against code screenshots. That would at least make the process a bit easier. But, 'the developers won't read the docs' is never good a reason to toss them completely.Eric King– Eric King2013-04-23 20:56:53 +00:00Commented Apr 23, 2013 at 20:56
| Show 12 more comments
How to Edit
- Correct minor typos or mistakes
- Clarify meaning without changing it
- Add related resources or links
- Always respect the author’s intent
- Don’t use edits to reply to the author
How to Format
- create code fences with backticks ` or tildes ~ ```
like so
``` - add language identifier to highlight code ```python
def function(foo):
print(foo)
``` - put returns between paragraphs
- for linebreak add 2 spaces at end
- _italic_ or **bold**
- indent code by 4 spaces
- backtick escapes
`like _so_` - quote by placing > at start of line
- to make links (use https whenever possible) <https://example.com>[example](https://example.com)<a href="https://example.com">example</a>
How to Tag
A tag is a keyword or label that categorizes your question with other, similar questions. Choose one or more (up to 5) tags that will help answerers to find and interpret your question.
- complete the sentence: my question is about...
- use tags that describe things or concepts that are essential, not incidental to your question
- favor using existing popular tags
- read the descriptions that appear below the tag
If your question is primarily about a topic for which you can't find a tag:
- combine multiple words into single-words with hyphens (e.g. design-patterns), up to a maximum of 35 characters
- creating new tags is a privilege; if you can't yet create a tag you need, then post this question without it, then ask the community to create it for you
lang-cs