Skip to content

Commit c3b6449

Browse files
authored
Update and rename poor-naming-conventions.md to improve-findability.md
Revised to align with PLoP paper updates.
1 parent e01e134 commit c3b6449

File tree

2 files changed

+63
-66
lines changed

2 files changed

+63
-66
lines changed

improve-findability.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
## Title
2+
3+
Improve Findability
4+
5+
## Also Known As
6+
7+
Badly Named Piles
8+
9+
## Context
10+
11+
Reusable software component(s) are available internally but users can't easily find them.
12+
This problem is more likely to occur in large, federated companies where different organizational units operate as silos.
13+
Historically, the company does not have a culture of sharing code across silos.
14+
15+
## Problem
16+
17+
People can't find the internally developed solutions that they need due to poor naming conventions.
18+
19+
## Forces
20+
21+
- The volume of contributions to inner source is impacting the ability to find components.
22+
- The internal search engine is not robust, or is not connected to git repositories (it can be difficult to make this change happen)
23+
- Cryptic naming conventions for projects and lack of keywords contribute to reduced findability.
24+
- People may lose confidence in the integrity of inner source and become discouraged from engaging when they search and don't find what they need.
25+
26+
27+
## Solution
28+
To help improve findability for inner source projects:
29+
- Provide guidelines for applying clear, meaningful naming conventions to projects, and reinforce the importance of avoiding cryptic code names.
30+
- Include keywords in project descriptions.
31+
- Apply tagging to repositories (validated).
32+
- Use labels where possible.
33+
- If possible, pull repository names, descriptions, and README.md files into the search engine (not the code itself).
34+
- Instate a concierge service (guide) to help product people find stuff. (This approach might not scale, but could be helpful at the beginning of a program.)
35+
36+
37+
<img alt="Poor naming conventions" src="/assets/img/poornamingconventions.jpg" width="70%">
38+
39+
## Known instances
40+
None known as of yet---this is a pattern idea until it is proven.
41+
42+
## Desired Resulting Context
43+
44+
- Internal components are visible.
45+
- Developers looking for code can search for it and find it quickly.
46+
- Developers are now looking internally for software components.
47+
- Increased reuse, faster time to market.
48+
- Increased collaboration.
49+
- Higher quality code.
50+
- Increased opportunities for innovation.
51+
52+
## Status
53+
54+
Brainstormed pattern idea reviewed 2017-03-11.
55+
56+
## Authors
57+
58+
- Georg Grutter (Robert Bosch GmbH)
59+
- Diogo Fregonese (Robert Bosch GmbH)
60+
- Erin Bank (CA Technologies)
61+
- Padma Sudarsan (Nokia)
62+
- Tim Yao (Nokia)
63+

poor-naming-conventions.md

Lines changed: 0 additions & 66 deletions
This file was deleted.

0 commit comments

Comments
 (0)