Skip to content

Commit d2bd144

Browse files
committed
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
1 parent 55a02d6 commit d2bd144

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/get-started/intro.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Want to use the Docker image? [Check it out](https://github.com/doc-detective/do
1515

1616
See the [Installation](/docs/get-started/installation.md) guide to get started. Come chat on [Discord](https://discord.gg/uAfSjVH7yr)!
1717

18-
## What is Doc Detective?
18+
## What's Doc Detective?
1919

2020
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.
2121

@@ -27,13 +27,13 @@ Doc Detective can do a lot, especially with a bit of creativity.
2727

2828
### Test documentation for accuracy/freshness
2929

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:
3131

3232
- Existence of page elements
3333
- Written text (such as a heading or a button string)
3434
- Screenshots
3535
- Links
36-
- API endpoints, functionality, and responses
36+
- API endpoints, capabilities, and responses
3737
- Anything you can write a script to verify
3838

3939
### Generate screenshots or video to accompany documentation
@@ -54,9 +54,9 @@ While Doc Detective can write tests from scanning your documentation, it can’t
5454

5555
## Who is Doc Detective for?
5656

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 open source and accessible project, Doc Detective is for anyone who's interested. More specifically, here are some groups who could benefit:
5858

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.
6060
- **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.
6161
- **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.
6262

0 commit comments

Comments
 (0)