Best Practices for Maintaining CyberArk Project Documentation

cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 
Announcements

Welcome Idira to LIVEcommunity!

Our community just got stronger! Explore new identity security resources, connect with experts, and discover more ways to learn and collaborate.

Meet Idira

Best Practices for Maintaining CyberArk Project Documentation

L3 Networker

Hello everyone,

 

I am currently working on a CyberArk project, and as part of the implementation, I need to prepare and maintain a variety of documents, such as step-by-step guides, configurations, troubleshooting steps, and best practices.

 

Right now, I am documenting everything in simple MS Word files and storing them in a folder structure. While this works fine for now, I am concerned that as the project grows, managing these documents may become cumbersome. Searching for specific information, version control, and collaboration with team members might become challenging.

 

I would like to know if there are any best practices or recommended tools to efficiently document and manage a CyberArk project. Some aspects I am considering:

 

Easy searchability and organization

Version control and change tracking

Collaboration features for multiple team members

Secure storage and controlled access

If anyone has experience with this or can suggest an efficient approach, your insights would be highly appreciated. Looking forward to learning from the community!

 

Thanks in advance!

1 accepted solution

Accepted Solutions

L7 Applicator

Hi @TAIFUL KHAN​ 

 

You can leverage Confluence or SharePoint or GitBook (version control) to structure and manage the documentations.

 

Some of the folders structure you can have included are,

 

Project Overview

Implementation Guides

Configuration Steps

Troubleshooting & Known Issues

Best Practices & Recommendations

Change Logs & Updates

Vendor documents and KB links

 

 

Hope it helps !

 

View solution in original post

5 REPLIES 5

L7 Applicator

Hi @TAIFUL KHAN​ 

 

You can leverage Confluence or SharePoint or GitBook (version control) to structure and manage the documentations.

 

Some of the folders structure you can have included are,

 

Project Overview

Implementation Guides

Configuration Steps

Troubleshooting & Known Issues

Best Practices & Recommendations

Change Logs & Updates

Vendor documents and KB links

 

 

Hope it helps !

 

Thanks for your suggestion!

L4 Transporter

One suggestion I have: Don't put information such as current software versions (as in - which CyberArk verison is the Vault running, which Chrome version is installed on PSM, etc...) into the documentation, because it will be outdated very quickly.

 

Instead, check if you can configure your monitoring solution or SIEM solution (Zabbix, Splunk, Nagios, ...) to retrieve it and give you that information in a dashboard. That way, you always have the correct information about what is *actually* running on your CyberArk PAS components.

L4 Transporter

Hi @TAIFUL KHAN​ 

 

Since several community members answered your question, please let us know if these solutions addressed your query.

If so, it would be great if you could mark the most helpful response as 'Select as Best' to assist other community members with similar questions.

 

Thank you, Liad.

Done !

  • 1 accepted solution
  • 194 Views
  • 5 replies
  • 0 Likes
Like what you see?

Show your appreciation!

Click Like if a post is helpful to you or if you just want to show your support.

Click Accept as Solution to acknowledge that the answer to your question has been provided.

The button appears next to the replies on topics you’ve started. The member who gave the solution and all future visitors to this topic will appreciate it!

These simple actions take just seconds of your time, but go a long way in showing appreciation for community members and the LIVEcommunity as a whole!

The LIVEcommunity thanks you for your participation!