The document discusses solutions for when documentation avoidance fails. It recommends using plain text formats like Markdown or AsciiDoc to write documentation, keeping documentation and code together, integrating documentation into development processes using tools like Git, Maven and Docker, and automating documentation testing and generation as much as possible. The document provides examples of using Arquillian, Maven, AShot and Graphene to automate the creation of a user manual with screenshots from automated tests. The goal is to produce an up-to-date user manual with high test coverage through continuous integration of documentation with code.
37. MARKDOWN
+ light weight
+ easy to write
+ easy to read
- limited
A First Level Header
====================
A Second Level Header
---------------------
Now is the time for all good men to come to
the aid of their country. This is just a
regular paragraph.
The quick brown fox jumped over the lazy
dog's back.
### Header 3
> This is a blockquote.
>
> This is the second paragraph in the blockquote.
>
> ## This is an H2 in a blockquote
38. FIRST THERE WAS MARKDOWN
Markdown(John Gruber)
http://daringfireball.net/projects/markdown
39. THEN THERE WAS MARKDOWN
Markdown
Github Flavored
Markdown Extra
MultiMarkdown
(John Gruber)
40. THEN THERE WAS MARKDOWN
Markdown
Github Flavored
Markdown Extra
MultiMarkdown
CommonMark
https://xkcd.com/927/
41. ASCIIDOCTOR
+ medium weight
+ easy to write
+ easy to read
+ comprehensive
+ maven support
+ 1 version
# A First Level Header
## A Second Level Header
Now is the time for all good men to come to
the aid of their country. This is just a
regular paragraph.
The quick brown fox jumped over the lazy
dog's back.
### Header 3
> This is a blockquote.
>
> This is the second paragraph in the blockquote.
>
> ## This is an H2 in a blockquote
55. I have made this longer than usual because I
have not had time to make it shorter.
56. I have made this longer than usual because I
have not had time to make it shorter.
57. screenshots
are always
out-of-date
Windows™ 10 Admin Guide
1. Logging in
An administrator is someone who can make changes on a computer
that will affect other users of the computer. Administrators can change
security settings, install software and hardware, access all files on the
computer, and make changes to other user accounts. To log on as an
administrator, you need to have a user account on the computer with
an Administrator account type.
If your account type is not Administrator, then you cannot log on as an
administrator unless you know the user name password for another
72. Skips a test
if the issue is not done.
Runs a test
if the issue is done.
Closes a issue
if the test is successful
http://arquillian.org/
integration
@Test
@Jira("ARQ-1907")
public void test1() {
}
@Test
@Github("123")
public void test2() {
}