Skip to content

Intro an Enterprise Search Tool #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ntache-81 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Intro an Enterprise Search Tool #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 39 additions & 24 deletions practices/implement-a-documentation-search-engine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,45 +1,60 @@
# Implement A Documentation Search Engine
# Introduce an Enterprise Search Tool

Under Construction
When critical system knowledge is locked away in the minds of a few tenured employees, bottlenecks are created, onboarding slows, and reliance on key personnel increases. Incomplete or outdated context will always lead to rework. An enterprise search tool like [Glean](https://www.glean.com/enterprise-search-software) or [Claude for Enterprise](https://claude.ai/login?returnTo=%2F%3F) unifies access to information across JIRA, Confluence, SVN, shared drives, and more. This allows teams to quickly find what they need without interrupting others or digging through multiple systems that require specialized knowledge.

<!--
# Practice Title
## When to Experiment

Description
“I am a new developer and I need to learn how to find accurate, updated documentation so I can onboard quickly and easily.”

## Nuances
“I am a QA team member and I need to ensure I have quick access to system knowledge so I can avoid wasting time sifting through multiple systems.”

### Nuance #N
“I am a developer and I need to ensure I have access to complete and up-to-date requirements so I can produce quality tickets and avoid QA rejections.”

Nuance Description
“I am a senior team member and I need to ensure that specialized knowledge is accessible so I can reduce interruptions and boost team autonomy.”

## How to Improve
## How to Gain Traction

### [Lead Workshops](/practices/lead-workshops.md)
[Pragmint to complete]

#### Workshop Title
List 3–5 steps to take a team from zero to adopted.
For each step, include:
### [Action Step]
3 sentences on how to do it, how to get buy-in, and what tools/resources help. Any external resources (videos, guides, book lists, templates, etc.) that help a team adopt this practice should be linked here within the relevant action step.

Workshop Description
## Lessons From The Field

### [Start A Book Club](/practices/start-a-book-club.md)
[Pragmint to complete]

#### Title Of Book Or Article
This section captures real-world patterns (things that consistently help or hinder this practice) along with short, relevant stories from the field. It’s not for personal rants or generic opinions. Each entry must be based on either:
1. a repeated observation across teams, or
2. a specific example (what worked, what didn’t, and why).

Description of Book or Article
## Deciding to Polish or Pitch

### [Host A Viewing Party](/practices/host-a-viewing-party.md)
After experimenting with this practice for [insert appropriate quantity of time in bold], bring the team together to determine whether the following metrics and/or signals have changed in a positive direction:

#### Title Of Video
### Fast & Measurable

Description of Video
Improved ticket quality and fewer QA rejections due to incomplete or unclear requirements

### [Host A Roundtable Discussion](/practices/host-a-roundtable-discussion.md)
### Slow & Measurable

List of questions to guide the roundtable discussion
Increased self-service search usage, indicating trust and utility in the tool

## Supporting Capabilities
Reduced onboarding time for new developers and QA (time to first merged PR or tested ticket)

### Related DORA Capability
### Slow & Intangible

Description of how this practice supports the DORA Capability
-->
Lower interruption load on senior team members (tracked by volume of support requests sent via Teams chat)

Fewer context-gathering delays in ticket implementation (measured via cycle time or qualitative developer feedback)

## Supported Capabilities

### [Learning Culture](https://github.com/pragmint/open-practices/blob/main/capabilities/learning-culture.md))

By centralizing institutional knowledge and making it accessible, enterprise search should boost team autonomy, reduce wasted time, and support a healthier learning culture.

### [Documentation Quality](https://github.com/pragmint/open-practices/blob/main/capabilities/documentation-quality.md))

Excellent documentation is accurate, clear, complete, and accessible to internal teams. This enables teams to effectively collaborate, make informed decisions, and deliver high-quality software quickly and reliably.