|
1 | 1 | # GuideAutomator
|
| 2 | + |
2 | 3 | [](https://badge.fury.io/js/guide-automator)
|
3 | 4 | [](https://nodejs.org/en/download/)
|
4 |
| -[](https://david-dm.org/allan1/guide-automator) |
| 5 | +[](https://david-dm.org/aside-ufba/guide-automator) |
5 | 6 |
|
6 | 7 | [](https://nodei.co/npm/guide-automator/)
|
7 | 8 | > Automated User Guide Generation with Markdown
|
8 | 9 |
|
| 10 | +GuideAutomator allows developers and technical writers to create user manuals with screenshots that are always in sync with the latest version of the application being documented. For that end, it takes as input a Markdown file containing the user manual text with short JavaScript chunks that determine how to capture each screencast. |
| 11 | + |
| 12 | +Sample GuideAutomator input: |
| 13 | + |
| 14 | + ## How to find GuideAutomator |
| 15 | + |
| 16 | + Open the Bing website and type `GuideAutomator aside-ufba`: |
| 17 | + |
| 18 | + ```javascript |
| 19 | + get('https://bing.com/'); |
| 20 | + fillIn('#sb_form_q', 'GuideAutomator aside-ufba'); |
| 21 | + takeScreenshotOf('#sb_form>div', true); |
| 22 | + ``` |
| 23 | + |
| 24 | + Press *Enter*. The first result should be what you are looking for: |
| 25 | + |
| 26 | + ```javascript |
| 27 | + submit('#sb_form'); |
| 28 | + takeScreenshotOf('#b_results>li:nth-child(1)', true); |
| 29 | + ``` |
| 30 | + |
| 31 | +Corresponding output: |
| 32 | + |
| 33 | + |
| 34 | + |
| 35 | +GuideAutomator was proposed by professor [Rodrigo Souza](https://github.com/rodrigorgs) and originally implemented by [Allan Oliveira](https://github.com/rodrigorgs) as part of his [Bachelor's thesis](https://repositorio.ufba.br/ri/bitstream/ri/20947/1/monografia-allan-versao-final.pdf). The project is now being maintained by [Welbert Serra](https://github.com/welbert). The project is being developed in the context of [aSide](https://translate.google.com/translate?sl=pt&tl=en&js=y&prev=_t&hl=en&ie=UTF-8&u=http%3A%2F%2Fwiki.dcc.ufba.br%2FAside%2F&edit-text=&act=url), a research group at the [Federal University of Bahia](https://en.wikipedia.org/wiki/Federal_University_of_Bahia) specialized in software design and evolution. |
| 36 | + |
| 37 | +--- |
| 38 | + |
| 39 | +## Summary |
| 40 | + |
9 | 41 | - [Installation](#installation)
|
10 | 42 | - [Prerequisites](#prerequisites)
|
11 | 43 | - [Linux](#linux)
|
@@ -306,11 +338,3 @@ See [raw](https://raw.githubusercontent.com/Allan1/guide-automator/master/exampl
|
306 | 338 | [Selenium Documentation](https://seleniumhq.github.io/selenium/docs/api/javascript/module/selenium-webdriver/chrome_exports_Driver.html)
|
307 | 339 |
|
308 | 340 | [back to top](#guideautomator)
|
309 |
| - |
310 |
| -## Author |
311 |
| -### [Allan Oliveira](https://github.com/Allan1) |
312 |
| - |
313 |
| -### Contributors |
314 |
| - * [Welbert Serra](https://github.com/welbert) |
315 |
| - |
316 |
| -[back to top](#guideautomator) |
|
0 commit comments