Articles on: Getting started

Leantime’s Wiki Docs

Created by Marcel Folaron,
Last Updated: 27 Oct 2023 at 03:49 PM by Marcel Folaron

In Leantime, we want to make sure you have the tools you need for a successful project all in one place. To achieve this, we integrated a wiki documentation system with our platform, helping your team collaborate, create, and organize all project-related information in one location.

Wiki vs. Knowledge Base

A Wiki Documentation system, or a 'Wiki', is generally a central database filled with project or company guidelines and information. It can be accessed and edited by anyone on the project, thus facilitating the collaboration that Wikis are known for. Wiki’s are different from knowledge bases mainly in who gets to access and edit the information stored in them. While Wikis have many collaborators and store lots of information, knowledge bases are more formal libraries storing official information maintained by specific authors.

Leantime encourages teams to use a wiki documentation system for resources like Product Requirments Documents, Project Outlines, User Stories, Bugs, and Feature Requests.

Getting Started With Wiki Docs

To begin creating your first Doc, navigate to the Docs tab on the left side of the screen.

Leantime automatically creates a wiki for you called “Default”. To change the title of the wiki, click the three dots in the top right corner and select “Edit this Wiki”. Here you can enter a new name and click save. If you want to create a whole new Wiki click the drop-down arrow next to the title of your Wiki. Here you can switch to another Wiki or create a new one.

Once you have set up your wiki, it's time to create your first doc. Click on the "+ Create Article" button in the middle of the page. This will open up a window where you can edit the name, icon, parent doc, status, tags, and contents of your article.

Don’t forget to hit save when you’re done!

Leantime offers a range of useful tools in its Docs Toolbar to help you create and format your content effectively.

The first block of the toolbar has clickable icons to bold, italicize, or strikethrough your text. Next, you'll see two drop-down menus for choosing the format and color of your text. The middle block shows three icons for the alignment options of your text. The fourth block has icons to insert hyperlinks, insert images, insert media, embed docs, slides, or sheets, and add emojis. The fifth block is where you can add checkmarks, bullet points, or lists. The last three tools are to add a table, insert a code snippet or choose one of Leantime’s custom templates.

You can also use slash commands to easily access editing tools, templates, and even add confetti?. Simply type "/" and choose from the drop-down list that appears.

Image Sizing

Leantime’s tool to add images or video allows you to select the file you want to display, the width, and height of the media. The aspect ratio of your picture will stay the same no matter the width or height you set it to. This ensures your picture will not get warped. All of the following images and suggestions are based on a 13-inch screen.

Small Image: we recommend starting with a width and height below 100 pixels.

Medium Image: we recommend setting the width and height to around 200 pixels.

Large Image: we recommend setting the width and height to around 500 pixels.

Xtra-Large Image: This image will fill up most of the page. You’ll want the width and height to be around 800-1000 pixels. Anything more than that has the chance it might not fit on a single page.

Embedding a Document

Leantime’s wiki documentation system gives you the ability to collect all your Google Docs, Sheets, and Slides in one place. To embed a resource simply copy and paste the URL into the text box in our embed tool.

You can change the width and height of the embedded resource by clicking and dragging one of the corners, just like a photo. Any changes you make to the resource in Leantime will be reflected in that same resource in your normal Google editor. Make sure you’re signed into a Google account that has access to the resource!

Editing Existing Articles

In the case you already have an article created you can easily edit your doc by selecting it from the “Contents” bar on the left side of the screen and clicking “Edit Article” in the top right of the screen. From there you can edit any of the existing details in your article and even attach a milestone, the screen should look similar to the edit screen you saw when you first created the document.

You can also add comments and view other teammates' comments in the Discussion section of the document. To easily copy the URL to your document, click the link icon next to the “Edit Article” button.

To delete an article, in the edit screen of the doc you wish to delete, click the “Delete Article” button in the bottom right corner. You will no longer see the document in your wiki.