You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Revise introduction documentation for clarity and consistency
- Change "What is Doc Detective?" to "What's Doc Detective?"
- Update phrasing for better readability in the capabilities section
- Improve wording in the target audience description
Copy file name to clipboardExpand all lines: docs/get-started/intro.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ Want to use the Docker image? [Check it out](https://github.com/doc-detective/do
15
15
16
16
See the [Installation](/docs/get-started/installation.md) guide to get started. Come chat on [Discord](https://discord.gg/uAfSjVH7yr)!
17
17
18
-
## What is Doc Detective?
18
+
## What's Doc Detective?
19
19
20
20
Doc Detective is a doc content testing framework that simplifies the process of keeping your docs accurate and up-to-date. You write tests, and Doc Detective runs them directly against your product to ensure your docs match your user experience. Whether it’s a UI-based process or a series of API calls, Doc Detective can help you find doc bugs before your users do.
21
21
@@ -27,13 +27,13 @@ Doc Detective can do a lot, especially with a bit of creativity.
27
27
28
28
### Test documentation for accuracy/freshness
29
29
30
-
Doc Detective’s core strength is the ability to systematically check each and every element of your documentation for adherence to the reality of your product. Each of the following items can be inspected:
30
+
Doc Detective’s core strength is the ability to systematically check each and every element of your documentation for adherence to the reality of your product. You can inspect each of the following items:
31
31
32
32
- Existence of page elements
33
33
- Written text (such as a heading or a button string)
34
34
- Screenshots
35
35
- Links
36
-
- API endpoints, functionality, and responses
36
+
- API endpoints, capabilities, and responses
37
37
- Anything you can write a script to verify
38
38
39
39
### Generate screenshots or video to accompany documentation
@@ -54,9 +54,9 @@ While Doc Detective can write tests from scanning your documentation, it can’t
54
54
55
55
## Who is Doc Detective for?
56
56
57
-
As an open-source and accessible project, Doc Detective is for anyone who is interested. More specifically, here are some groups who could benefit:
57
+
As an opensource and accessible project, Doc Detective is for anyone who's interested. More specifically, here are some groups who could benefit:
58
58
59
-
-**Small teams:** There’s often limited personnel or budget dedicated to a project, and documentation takes a backseat as a result. With Doc Detective, you can spend less time reviewing published documentation and trust that it is still functional and accurate for the end user.
59
+
-**Small teams:** There’s often limited personnel or budget dedicated to a project, and documentation often gets deprioritized as a result. With Doc Detective, you can spend less time reviewing published documentation and trust that it's still functional and accurate for the end user.
60
60
-**Large teams:** The more people you have contributing to a project, the faster it can change shape. In cases where development is outpacing documentation, Doc Detective keeps a watchful eye on the changes made and note any inconsistencies.
61
61
-**Anything in between:** You can be a team of one or of one thousand and still find a use for Doc Detective. When it comes time to address the documentation of your project, look to Doc Detective to ease the burden and help bring consistency and accuracy to the end user.
0 commit comments