Skip to main content

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*

17
  • 2
    Are there dedicated QA resources assigned to the project? Commented 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. Commented Apr 22, 2013 at 17:59
  • 2
    would 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. Commented Apr 22, 2013 at 18:21
  • 2
    I can't imagine why anybody would want screenshots of code, or in-code comments describing the UI. Neither seem particularly useful. Commented 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. Commented Apr 23, 2013 at 20:56